Skip to content
/
Bulk write 'Signabledocum...

Documents (2.0.0)

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

Fileaccessshare

Operations

Organizationuserfileaccessshare

Operations

Folder

Operations

Publicfile

Operations

Signabledocumentpartyfield

Operations

Signabledocument

Operations

Bulk write 'Signabledocument'

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 [
namestring<= 255 charactersrequired
content_typeobject or null(Contenttype)
is_templateboolean
attached_toobject or null(Signabledocument)
signed_timestring or null(date-time)
interpret_text_as_markdownboolean
finished_dataobject or null

Additional Validation Information:

This value requires that the following fields are also set: signing_started_time

document_fileobject or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: text_content

days_to_signinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: days_to_remind

object_idstring or null(uuid)
signing_initiatedboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
organizationobject or null(Organization)
signing_started_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signing_aborted_time

custom_idstring or null<= 128 characters
confirmation_messagestring or null
days_to_remindinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: days_to_sign

rejected_timestring or null(date-time)
external_sign_engineobject or null(Integrationuseragent)
formatted_data_to_signobject or null
text_contentstring or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: document_file

invitation_messagestring or null
signing_aborted_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signing_started_time

]
curl -i -X POST \
  https://dev.api.pigello.io/documents/signing/signabledocument/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 '[
    {
      "content_type": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "is_template": true,
      "attached_to": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "signed_time": "2019-08-24T14:15:22Z",
      "interpret_text_as_markdown": true,
      "finished_data": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "document_file": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "days_to_sign": 1,
      "name": "string",
      "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
      "signing_initiated": true,
      "category": 0,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "signing_started_time": "2019-08-24T14:15:22Z",
      "custom_id": "string",
      "confirmation_message": "string",
      "days_to_remind": 1,
      "rejected_time": "2019-08-24T14:15:22Z",
      "external_sign_engine": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "formatted_data_to_sign": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "text_content": "string",
      "invitation_message": "string",
      "signing_aborted_time": "2019-08-24T14:15:22Z"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

content_typeobject or null(Contenttype)
is_templateboolean
data_to_signobject or nullread-only
attached_toobject or null(Signabledocument)
customer_columnsanyread-only
signed_timestring or null(date-time)
interpret_text_as_markdownboolean
finished_dataobject or null

Additional Validation Information:

This value requires that the following fields are also set: signing_started_time

document_fileobject or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: text_content

days_to_signinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: days_to_remind

created_atstring(date-time)read-only
object_idstring or null(uuid)
signing_initiatedboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
organizationobject or null(Organization)
signing_started_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signing_aborted_time

custom_idstring or null<= 128 characters
confirmation_messagestring or null
days_to_remindinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: days_to_sign

rejected_timestring or null(date-time)
tagsanyread-only
external_sign_engineobject or null(Integrationuseragent)
formatted_data_to_signobject or null
text_contentstring or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: document_file

invitation_messagestring or null
signing_aborted_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signing_started_time

]
Response
application/json
[
  {
    "content_type": { … },
    "is_template": true,
    "data_to_sign": { … },
    "attached_to": { … },
    "customer_columns": null,
    "signed_time": "2019-08-24T14:15:22Z",
    "interpret_text_as_markdown": true,
    "finished_data": { … },
    "document_file": { … },
    "days_to_sign": 1,
    "created_at": "2019-08-24T14:15:22Z",
    "name": "string",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "signing_initiated": true,
    "category": 0,
    "organization": { … },
    "signing_started_time": "2019-08-24T14:15:22Z",
    "custom_id": "string",
    "confirmation_message": "string",
    "days_to_remind": 1,
    "rejected_time": "2019-08-24T14:15:22Z",
    "tags": null,
    "external_sign_engine": { … },
    "formatted_data_to_sign": { … },
    "text_content": "string",
    "invitation_message": "string",
    "signing_aborted_time": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
]

Get 'Signabledocument'

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/documents/signing/signabledocument/{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
namestring<= 255 charactersrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

content_typeobject or null(Contenttype)
is_templateboolean
data_to_signobject or nullread-only
attached_toobject or null(Signabledocument)
customer_columnsanyread-only
signed_timestring or null(date-time)
interpret_text_as_markdownboolean
finished_dataobject or null

Additional Validation Information:

This value requires that the following fields are also set: signing_started_time

document_fileobject or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: text_content

days_to_signinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: days_to_remind

created_atstring(date-time)read-only
object_idstring or null(uuid)
signing_initiatedboolean
categoryinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum0123456
organizationobject or null(Organization)
signing_started_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signing_aborted_time

custom_idstring or null<= 128 characters
confirmation_messagestring or null
days_to_remindinteger or null(int32)[ 1 .. 2147483647 ]

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: days_to_sign

rejected_timestring or null(date-time)
tagsanyread-only
external_sign_engineobject or null(Integrationuseragent)
formatted_data_to_signobject or null
text_contentstring or null

Additional Validation Information:

This value can't bet set, when any of the following fields are set: document_file

invitation_messagestring or null
signing_aborted_timestring or null(date-time)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: signing_started_time

Response
application/json
{
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_template": true,
  "data_to_sign": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "attached_to": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "signed_time": "2019-08-24T14:15:22Z",
  "interpret_text_as_markdown": true,
  "finished_data": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "document_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "days_to_sign": 1,
  "created_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "signing_initiated": true,
  "category": 0,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "signing_started_time": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "confirmation_message": "string",
  "days_to_remind": 1,
  "rejected_time": "2019-08-24T14:15:22Z",
  "tags": null,
  "external_sign_engine": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "formatted_data_to_sign": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "text_content": "string",
  "invitation_message": "string",
  "signing_aborted_time": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Delete 'Signabledocument'

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/documents/signing/signabledocument/{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

Signabledocumentparty

Operations
© Pigello. All rights reserved.