Skip to content
/
Create 'Tenantinformation...

Communication (2.0.0)

The 'Communication' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Tenantinformationcollectionfile

Operations

Get 'Tenantinformationcollectionfile'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollectionfile/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

collectionobject(Tenantinformationcollection)required
collection.​idstring(uuid)
file_objobjectrequired
file_obj.​namestring

wanted filename of the file

file_obj.​md5_hashstring

base64 encoded md5hash of the file

file_obj.​getstring(url)
file_obj.​postobject
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
display_namestring or null<= 255 characters
created_atstring(date-time)read-only
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "display_priority": -2147483648,
  "file_obj": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "display_name": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Create 'Tenantinformationcollectionfile'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
collectionobject(Tenantinformationcollection)required
collection.​idstring(uuid)
file_objobjectrequired
file_obj.​namestring

wanted filename of the file

file_obj.​md5_hashstring

base64 encoded md5hash of the file

file_obj.​getstring(url)
file_obj.​postobject
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
display_namestring or null<= 255 characters
curl -i -X POST \
  https://dev.api.pigello.io/communication/tenantinformation/tenantinformationcollectionfile/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "collection": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "display_priority": -2147483648,
    "file_obj": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "display_name": "string"
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

collectionobject(Tenantinformationcollection)required
collection.​idstring(uuid)
file_objobjectrequired
file_obj.​namestring

wanted filename of the file

file_obj.​md5_hashstring

base64 encoded md5hash of the file

file_obj.​getstring(url)
file_obj.​postobject
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
display_namestring or null<= 255 characters
created_atstring(date-time)read-only
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "collection": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "display_priority": -2147483648,
  "file_obj": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "display_name": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Faqentry

Operations

Tenantinformationcollection

Operations
© Pigello. All rights reserved.