Skip to content

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

Faqentry

Operations

Bulk write 'Faqentry'

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/jsonArray [
collectionobject(Tenantinformationcollection)required
collection.​idstring(uuid)
answerstringrequired
questionstringrequired
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
file_objobject or null
organizationobject or null(Organization)
]
curl -i -X POST \
  https://dev.api.pigello.io/communication/tenantinformation/faqentry/list/ \
  -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"
      },
      "display_priority": -2147483648,
      "custom_id": "string",
      "answer": "string",
      "file_obj": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "question": "string",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
collectionobject(Tenantinformationcollection)required
collection.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

answerstringrequired
questionstringrequired
created_atstring(date-time)read-only
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
file_objobject or null
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "collection": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "display_priority": -2147483648,
    "custom_id": "string",
    "answer": "string",
    "file_obj": { … },
    "question": "string",
    "organization": { … }
  }
]

List 'Faqentry'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
global_realestatesArray of objects
global_segmentsArray of objects
answerany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

collectionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

display_priorityany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

questionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/communication/tenantinformation/faqentry/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -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 query

Bodyapplication/jsonArray [
collectionobject(Tenantinformationcollection)required
collection.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

answerstringrequired
questionstringrequired
created_atstring(date-time)read-only
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
file_objobject or null
organizationobject or null(Organization)
]
Response
application/json
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "collection": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "display_priority": -2147483648,
    "custom_id": "string",
    "answer": "string",
    "file_obj": { … },
    "question": "string",
    "organization": { … }
  }
]

Create 'Faqentry'

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)
answerstringrequired
questionstringrequired
display_priorityinteger(int32)[ -2147483648 .. 2147483647 ]
custom_idstring or null<= 128 characters
file_objobject or null
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/communication/tenantinformation/faqentry/ \
  -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"
    },
    "display_priority": -2147483648,
    "custom_id": "string",
    "answer": "string",
    "file_obj": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "question": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
collectionobject(Tenantinformationcollection)required
collection.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

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

Tenantinformationcollection

Operations
© Pigello. All rights reserved.