Skip to content
/
Create 'Folder'

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

Delete 'Folder'

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/filehandling/folder/{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

Create 'Folder'

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
contains_files_with_personal_databooleanrequired
notation_content_typeobject(Contenttype)required

Additional Validation Information:

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

notation_content_type.​idstring(uuid)
namestring[ 3 .. 255 ] charactersrequired
notation_object_idstring(uuid)required

Additional Validation Information:

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

folderobject or null(Folder)
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
access_shareobject or null(Fileaccessshare)
privateboolean
colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'
curl -i -X POST \
  https://dev.api.pigello.io/documents/filehandling/folder/ \
  -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 '{
    "folder": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "contains_files_with_personal_data": true,
    "notation_content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "access_share": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "private": true,
    "name": "string",
    "notation_object_id": "6eb2c520-3187-4289-a8b8-c2ab0582af19",
    "color": "string"
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

contains_files_with_personal_databooleanrequired
notation_content_typeobject(Contenttype)required

Additional Validation Information:

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

notation_content_type.​idstring(uuid)
namestring[ 3 .. 255 ] charactersrequired
notation_object_idstring(uuid)required

Additional Validation Information:

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

folderobject or null(Folder)
created_byobject or null(Organizationuser)read-only
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
access_shareobject or null(Fileaccessshare)
created_atstring(date-time)read-only
privateboolean
colorstring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'
Response
application/json
{
  "folder": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_by": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "contains_files_with_personal_data": true,
  "notation_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "access_share": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "private": true,
  "name": "string",
  "notation_object_id": "6eb2c520-3187-4289-a8b8-c2ab0582af19",
  "color": "string"
}

Publicfile

Operations

Signabledocumentpartyfield

Operations

Signabledocument

Operations

Signabledocumentparty

Operations
© Pigello. All rights reserved.