Skip to content
/
Bulk write 'Note'

Annotating (2.0.0)

The 'Annotating' 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

Customercolumnvalue

Operations

Tag

Operations

Customercolumntype

Operations

Note

Operations

Create 'Note'

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
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
contentstringrequired
object_idstring(uuid)required
organizationobject or null(Organization)
privateboolean
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/annotating/note/ \
  -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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "private": true,
    "content": "string",
    "custom_id": "string",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
  }'

Responses

Successful creation

Bodyapplication/json
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
contentstringrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

object_idstring(uuid)required
organizationobject or null(Organization)
written_by_organization_userobject or null(Organizationuser)read-only
privateboolean
written_by_tenantobject or null(Tenant)read-only
written_by_sub_tenantobject or null(Subtenant)read-only
updated_atstring(date-time)read-only
written_by_integration_userobject or null(Integrationuseragent)read-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "written_by_organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "private": true,
  "written_by_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "written_by_sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "written_by_integration_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "content": "string",
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
}

Update 'Note'

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
Bodyapplication/json
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
contentstringrequired
object_idstring(uuid)required
organizationobject or null(Organization)
privateboolean
custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/annotating/note/{pk}/' \
  -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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "private": true,
    "content": "string",
    "custom_id": "string",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
  }'

Responses

Successful update

Bodyapplication/json
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
contentstringrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

object_idstring(uuid)required
organizationobject or null(Organization)
written_by_organization_userobject or null(Organizationuser)read-only
privateboolean
written_by_tenantobject or null(Tenant)read-only
written_by_sub_tenantobject or null(Subtenant)read-only
updated_atstring(date-time)read-only
written_by_integration_userobject or null(Integrationuseragent)read-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "written_by_organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "private": true,
  "written_by_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "written_by_sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "written_by_integration_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "content": "string",
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
}

Delete 'Note'

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 DELETE \
  'https://dev.api.pigello.io/annotating/note/{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 deletion

Response
No content

Get 'Note'

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/annotating/note/{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
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
contentstringrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

object_idstring(uuid)required
organizationobject or null(Organization)
written_by_organization_userobject or null(Organizationuser)read-only
privateboolean
written_by_tenantobject or null(Tenant)read-only
written_by_sub_tenantobject or null(Subtenant)read-only
updated_atstring(date-time)read-only
written_by_integration_userobject or null(Integrationuseragent)read-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "written_by_organization_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "private": true,
  "written_by_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "written_by_sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "written_by_integration_user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "content": "string",
  "custom_id": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
}

Bulk write 'Note'

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 [
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
contentstringrequired
object_idstring(uuid)required
organizationobject or null(Organization)
privateboolean
custom_idstring or null<= 128 characters
]
curl -i -X POST \
  https://dev.api.pigello.io/annotating/note/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 '[
    {
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "content_type": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "private": true,
      "content": "string",
      "custom_id": "string",
      "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
contentstringrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

object_idstring(uuid)required
organizationobject or null(Organization)
written_by_organization_userobject or null(Organizationuser)read-only
privateboolean
written_by_tenantobject or null(Tenant)read-only
written_by_sub_tenantobject or null(Subtenant)read-only
updated_atstring(date-time)read-only
written_by_integration_userobject or null(Integrationuseragent)read-only
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
]
Response
application/json
[
  {
    "organization": { … },
    "content_type": { … },
    "written_by_organization_user": { … },
    "private": true,
    "written_by_tenant": { … },
    "written_by_sub_tenant": { … },
    "updated_at": "2019-08-24T14:15:22Z",
    "written_by_integration_user": { … },
    "created_at": "2019-08-24T14:15:22Z",
    "content": "string",
    "custom_id": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb"
  }
]

Tagusage

Operations
© Pigello. All rights reserved.