POST /consignments

Body

  • uuid string Required
  • filename string Required
  • contentType string Required
  • size number Required
  • co_authors array[string]

    Array of email's co-authors

  • container string

    Container sent by CloudFactory if exist

  • checksum string

    Checksum sent by CloudFactory if exist

Responses

  • 201

    Consignment is created with success

    Hide response attributes Show response attributes object
    • success boolean Required

      Default value is true.

    • body object Required
      Hide body attribute Show body attribute object
      • id string

        The unique identifier of a consignment
  • 400

    Missing required body parameters

    Hide response attributes Show response attributes object
    • success boolean Required

      If request is succeed

      Default value is false.

    • message string Required

      A human readable error message

    • context string Required

      Context of error
  • 402

    Insufficient credit for organization

    Hide response attributes Show response attributes object
    • success boolean Required

      If request is succeed

      Default value is false.

    • message string Required

      A human readable error message

    • context string Required

      Context of error
  • 500

    Unexpected error

    Hide response attributes Show response attributes object
    • success boolean Required

      If request is succeed

      Default value is false.

    • message string Required

      A human readable error message

    • context string Required

      Context of error
POST /consignments 
curl \
 -X POST https://api.ziplo.fr/v1/public/consignments \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"uuid":"string","filename":"string","contentType":"string","size":42.0,"co_authors":["string"],"container":"string","checksum":"string"}'
Request example 
{
  "uuid": "string",
  "filename": "string",
  "contentType": "string",
  "size": 42.0,
  "co_authors": [
    "string"
  ],
  "container": "string",
  "checksum": "string"
}
Request examples 
{
  "uuid": "string",
  "filename": "string",
  "contentType": "string",
  "size": 42.0,
  "co_authors": [
    "string"
  ],
  "container": "string",
  "checksum": "string"
}
Response examples (201) 
{
  "success": true,
  "body": {
    "id": "string"
  }
}
Response examples (201) 
{
  "success": true,
  "body": {
    "id": "string"
  }
}
Response examples (400) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (400) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (402) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (402) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (500) 
{
  "success": false,
  "message": "string",
  "context": "string"
}
Response examples (500) 
{
  "success": false,
  "message": "string",
  "context": "string"
}