Skip to content

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

Create 'Signabledocumentpartyfield'

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
namestring<= 255 charactersrequired
partyobject(Signabledocumentparty)required
party.​idstring(uuid)
interpret_text_as_markdownboolean
position_y_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, font_size_rel

font_size_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, position_y_rel

autofill_value_instructionstring or null

Additional Validation Information:

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

rotate_placementinteger or null(int32)[ -360 .. 360 ]

Additional Validation Information:

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

organizationobject or null(Organization)
autofill_field_identifierstring or null<= 255 characters
Enum"outdoorsection__landlord_custom_id""subtenant__email""parkingspot__address.get_full_street_value""inspectionerrand__protocol_signed_time""generalerrand_organization_user_performers__custom_id""sub_tenant_signable_party__corporate_name""sub_tenant_signable_party__previous_address.attention""inspectionerrand_tenants__last_name""industrialpremises__address.get_verbose_value""organization_user_party__communication_name"
ask_for_inputboolean
page_numberinteger or null(int32)<= 2147483647

Additional Validation Information:

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

width_relnumber or null(float)<= 1

Additional Validation Information:

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

allow_reverse_autofill_on_completionboolean
height_relnumber or null(float)<= 1

Additional Validation Information:

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

manual_forced_valuestring or null
custom_idstring or null<= 128 characters
position_x_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_y_rel, font_size_rel

curl -i -X POST \
  https://dev.api.pigello.io/documents/signing/signabledocumentpartyfield/ \
  -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 '{
    "interpret_text_as_markdown": true,
    "position_y_rel": 1,
    "font_size_rel": 1,
    "autofill_value_instruction": "string",
    "rotate_placement": -360,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "autofill_field_identifier": "outdoorsection__landlord_custom_id",
    "ask_for_input": true,
    "page_number": 2147483647,
    "width_rel": 1,
    "name": "string",
    "allow_reverse_autofill_on_completion": true,
    "party": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "height_rel": 1,
    "manual_forced_value": "string",
    "custom_id": "string",
    "position_x_rel": 1
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
partyobject(Signabledocumentparty)required
party.​idstring(uuid)
interpret_text_as_markdownboolean
position_y_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, font_size_rel

font_size_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, position_y_rel

autofill_value_instructionstring or null

Additional Validation Information:

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

rotate_placementinteger or null(int32)[ -360 .. 360 ]

Additional Validation Information:

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

organizationobject or null(Organization)
autofill_field_identifierstring or null<= 255 characters
Enum"outdoorsection__landlord_custom_id""subtenant__email""parkingspot__address.get_full_street_value""inspectionerrand__protocol_signed_time""generalerrand_organization_user_performers__custom_id""sub_tenant_signable_party__corporate_name""sub_tenant_signable_party__previous_address.attention""inspectionerrand_tenants__last_name""industrialpremises__address.get_verbose_value""organization_user_party__communication_name"
ask_for_inputboolean
page_numberinteger or null(int32)<= 2147483647

Additional Validation Information:

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

created_atstring(date-time)read-only
width_relnumber or null(float)<= 1

Additional Validation Information:

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

allow_reverse_autofill_on_completionboolean
height_relnumber or null(float)<= 1

Additional Validation Information:

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

manual_forced_valuestring or null
custom_idstring or null<= 128 characters
position_x_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_y_rel, font_size_rel

Response
application/json
{
  "interpret_text_as_markdown": true,
  "position_y_rel": 1,
  "font_size_rel": 1,
  "autofill_value_instruction": "string",
  "rotate_placement": -360,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "autofill_field_identifier": "outdoorsection__landlord_custom_id",
  "ask_for_input": true,
  "page_number": 2147483647,
  "created_at": "2019-08-24T14:15:22Z",
  "width_rel": 1,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "allow_reverse_autofill_on_completion": true,
  "party": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "height_rel": 1,
  "manual_forced_value": "string",
  "custom_id": "string",
  "position_x_rel": 1
}

Bulk write 'Signabledocumentpartyfield'

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
partyobject(Signabledocumentparty)required
party.​idstring(uuid)
interpret_text_as_markdownboolean
position_y_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, font_size_rel

font_size_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, position_y_rel

autofill_value_instructionstring or null

Additional Validation Information:

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

rotate_placementinteger or null(int32)[ -360 .. 360 ]

Additional Validation Information:

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

organizationobject or null(Organization)
autofill_field_identifierstring or null<= 255 characters
Enum"outdoorsection__landlord_custom_id""subtenant__email""parkingspot__address.get_full_street_value""inspectionerrand__protocol_signed_time""generalerrand_organization_user_performers__custom_id""sub_tenant_signable_party__corporate_name""sub_tenant_signable_party__previous_address.attention""inspectionerrand_tenants__last_name""industrialpremises__address.get_verbose_value""organization_user_party__communication_name"
ask_for_inputboolean
page_numberinteger or null(int32)<= 2147483647

Additional Validation Information:

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

width_relnumber or null(float)<= 1

Additional Validation Information:

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

allow_reverse_autofill_on_completionboolean
height_relnumber or null(float)<= 1

Additional Validation Information:

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

manual_forced_valuestring or null
custom_idstring or null<= 128 characters
position_x_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_y_rel, font_size_rel

]
curl -i -X POST \
  https://dev.api.pigello.io/documents/signing/signabledocumentpartyfield/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 '[
    {
      "interpret_text_as_markdown": true,
      "position_y_rel": 1,
      "font_size_rel": 1,
      "autofill_value_instruction": "string",
      "rotate_placement": -360,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "autofill_field_identifier": "outdoorsection__landlord_custom_id",
      "ask_for_input": true,
      "page_number": 2147483647,
      "width_rel": 1,
      "name": "string",
      "allow_reverse_autofill_on_completion": true,
      "party": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "height_rel": 1,
      "manual_forced_value": "string",
      "custom_id": "string",
      "position_x_rel": 1
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
partyobject(Signabledocumentparty)required
party.​idstring(uuid)
interpret_text_as_markdownboolean
position_y_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, font_size_rel

font_size_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_x_rel, position_y_rel

autofill_value_instructionstring or null

Additional Validation Information:

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

rotate_placementinteger or null(int32)[ -360 .. 360 ]

Additional Validation Information:

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

organizationobject or null(Organization)
autofill_field_identifierstring or null<= 255 characters
Enum"outdoorsection__landlord_custom_id""subtenant__email""parkingspot__address.get_full_street_value""inspectionerrand__protocol_signed_time""generalerrand_organization_user_performers__custom_id""sub_tenant_signable_party__corporate_name""sub_tenant_signable_party__previous_address.attention""inspectionerrand_tenants__last_name""industrialpremises__address.get_verbose_value""organization_user_party__communication_name"
ask_for_inputboolean
page_numberinteger or null(int32)<= 2147483647

Additional Validation Information:

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

created_atstring(date-time)read-only
width_relnumber or null(float)<= 1

Additional Validation Information:

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

allow_reverse_autofill_on_completionboolean
height_relnumber or null(float)<= 1

Additional Validation Information:

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

manual_forced_valuestring or null
custom_idstring or null<= 128 characters
position_x_relnumber or null(float)<= 1

Additional Validation Information:

This value must be set together with the following fields: position_y_rel, font_size_rel

]
Response
application/json
[
  {
    "interpret_text_as_markdown": true,
    "position_y_rel": 1,
    "font_size_rel": 1,
    "autofill_value_instruction": "string",
    "rotate_placement": -360,
    "organization": { … },
    "autofill_field_identifier": "outdoorsection__landlord_custom_id",
    "ask_for_input": true,
    "page_number": 2147483647,
    "created_at": "2019-08-24T14:15:22Z",
    "width_rel": 1,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "allow_reverse_autofill_on_completion": true,
    "party": { … },
    "height_rel": 1,
    "manual_forced_value": "string",
    "custom_id": "string",
    "position_x_rel": 1
  }
]

Delete 'Signabledocumentpartyfield'

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/signabledocumentpartyfield/{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

Signabledocument

Operations

Signabledocumentparty

Operations
© Pigello. All rights reserved.