Skip to content
/
Create 'Publicfile'

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

Delete 'Publicfile'

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/publicfile/{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 'Publicfile'

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
contentobjectrequired
content.​namestring

wanted filename of the file

content.​md5_hashstring

base64 encoded md5hash of the file

content.​getstring(url)
content.​postobject
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X POST \
  https://dev.api.pigello.io/documents/filehandling/publicfile/ \
  -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 '{
    "custom_id": "string",
    "content": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
contentobjectrequired
content.​namestring

wanted filename of the file

content.​md5_hashstring

base64 encoded md5hash of the file

content.​getstring(url)
content.​postobject
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
Response
application/json
{
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "content": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Signabledocumentpartyfield

Operations

Signabledocument

Operations

Signabledocumentparty

Operations
© Pigello. All rights reserved.