dsp-ingest-projects v0.16.0

Servers

Description	URL
Local development server	http://localhost:3340
Production server	https://ingest.dasch.swiss

projects

---

GET /projects

Description

Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token

Response 200 OK

application/json

[
    {
        "id": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/ProjectResponse"
    }
}

Response headers

Name	Description	Schema
Content-Range		string

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

GET /projects/{shortcode}

Description

Authorization: read:project:1234 scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

application/json

{
    "id": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "ProjectResponse",
    "type": "object",
    "required": [
        "id"
    ],
    "properties": {
        "id": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

GET /projects/{shortcode}/checksumreport

Description

Authorization: read:project:1234 scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

application/json

{
    "summary": {
        "numberOfAssets": 49,
        "numberOfFiles": 26,
        "numberOfChecksumMatches": 254
    },
    "results": [
        {
            "assetId": "string",
            "originalFilename": "string",
            "results": [
                {
                    "filename": "string",
                    "checksumMatches": true
                }
            ]
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "AssetCheckResultResponse",
    "type": "object",
    "required": [
        "summary"
    ],
    "properties": {
        "summary": {
            "$ref": "#/components/schemas/AssetCheckResultSummary"
        },
        "results": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/AssetCheckResultEntry"
            }
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

DELETE /projects/{shortcode}/erase

Description

!ATTENTION! Erase a project with the given shortcode. This will permanently and irrecoverably remove the project and all of its assets. Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

application/json

{
    "id": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "ProjectResponse",
    "type": "object",
    "required": [
        "id"
    ],
    "properties": {
        "id": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

assets

---

GET /projects/{shortcode}/assets/{assetId}

Description

Authorization: read:project:1234 scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
assetId	path	string		No	The id of the asset
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

application/json

{
    "internalFilename": "string",
    "originalInternalFilename": "string",
    "originalFilename": "string",
    "checksumOriginal": "string",
    "checksumDerivative": "string",
    "width": 297,
    "height": 42,
    "duration": 10.12,
    "fps": 10.12,
    "internalMimeType": "string",
    "originalMimeType": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "AssetInfoResponse",
    "type": "object",
    "required": [
        "internalFilename",
        "originalInternalFilename",
        "originalFilename",
        "checksumOriginal",
        "checksumDerivative"
    ],
    "properties": {
        "internalFilename": {
            "type": "string"
        },
        "originalInternalFilename": {
            "type": "string"
        },
        "originalFilename": {
            "type": "string"
        },
        "checksumOriginal": {
            "type": "string"
        },
        "checksumDerivative": {
            "type": "string"
        },
        "width": {
            "type": "integer",
            "format": "int32"
        },
        "height": {
            "type": "integer",
            "format": "int32"
        },
        "duration": {
            "type": "number",
            "format": "double"
        },
        "fps": {
            "type": "number",
            "format": "double"
        },
        "internalMimeType": {
            "type": "string"
        },
        "originalMimeType": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

GET /projects/{shortcode}/assets/{assetId}/original

Description

Offers the original file for download, provided the API permisisons allow. Authorization: JWT bearer token.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
assetId	path	string		No	The id of the asset
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

application/octet-stream

"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "string",
    "format": "binary"
}

Response headers

Name	Description	Schema
Content-Disposition		string
Content-Type		string

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

POST /projects/{shortcode}/assets/ingest/{filename}

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
filename	path	string		No
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Request body

application/octet-stream

"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "string",
    "format": "binary"
}

Response 200 OK

application/json

{
    "internalFilename": "string",
    "originalInternalFilename": "string",
    "originalFilename": "string",
    "checksumOriginal": "string",
    "checksumDerivative": "string",
    "width": 147,
    "height": 287,
    "duration": 10.12,
    "fps": 10.12,
    "internalMimeType": "string",
    "originalMimeType": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "AssetInfoResponse",
    "type": "object",
    "required": [
        "internalFilename",
        "originalInternalFilename",
        "originalFilename",
        "checksumOriginal",
        "checksumDerivative"
    ],
    "properties": {
        "internalFilename": {
            "type": "string"
        },
        "originalInternalFilename": {
            "type": "string"
        },
        "originalFilename": {
            "type": "string"
        },
        "checksumOriginal": {
            "type": "string"
        },
        "checksumDerivative": {
            "type": "string"
        },
        "width": {
            "type": "integer",
            "format": "int32"
        },
        "height": {
            "type": "integer",
            "format": "int32"
        },
        "duration": {
            "type": "number",
            "format": "double"
        },
        "fps": {
            "type": "number",
            "format": "double"
        },
        "internalMimeType": {
            "type": "string"
        },
        "originalMimeType": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

bulk-ingest

---

POST /projects/{shortcode}/bulk-ingest

Description

Triggers an ingest on the project with the given shortcode. The files are expected to be in the tmp/<project_shortcode> directory. Will return 409 Conflict if a bulk-ingest is currently running for the project. Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 202 Accepted

application/json

{
    "id": "0001"
}

Schema of the response body

{
    "title": "ProjectResponse",
    "type": "object",
    "required": [
        "id"
    ],
    "properties": {
        "id": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

POST /projects/{shortcode}/bulk-ingest/finalize

Description

Finalizes the bulk ingest. This will remove the files from the tmp/<project_shortcode> directory and the directory itself. This will remove also the mapping.csv file. Will return 409 Conflict if a bulk-ingest is currently running for the project. Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

application/json

{
    "id": "0001"
}

Schema of the response body

{
    "title": "ProjectResponse",
    "type": "object",
    "required": [
        "id"
    ],
    "properties": {
        "id": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

GET /projects/{shortcode}/bulk-ingest/mapping.csv

Description

Get the current result of the bulk ingest. The result is a csv with the following structure: original,derivative. Will return 409 Conflict if a bulk-ingest is currently running for the project.Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

text/csv

"string"

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "string"
}

Response headers

Name	Description	Schema
Content-Type		string
Content-Disposition		string

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

POST /projects/{shortcode}/bulk-ingest/ingest/{file}

Description

Uploads a file for consumption with the bulk-ingest route.Will return 409 Conflict if a bulk-ingest is currently running for the project.Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
file	path	string		No
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Request body

application/octet-stream

"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "string",
    "format": "binary"
}

Response 200 OK

application/json

{
    "status": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "UploadResponse",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

import/export

---

POST /projects/{shortcode}/export

Description

Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Response 200 OK

application/zip

"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "string",
    "format": "binary"
}

Response headers

Name	Description	Schema
Content-Disposition		string
Content-Type		string

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

GET /projects/{shortcode}/import

Description

Authorization: admin scope required.

Input parameters

Parameter	In	Type	Default	Nullable	Description
httpAuth	header	string	N/A	No	JWT Bearer token
Content-Type	header	string		No
shortcode	path	string		No	The shortcode of the project must be an exactly 4 characters long hexadecimal string.

Request body

application/zip

"TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "string",
    "format": "binary"
}

Response 200 OK

application/json

{
    "status": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "UploadResponse",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

application/json

{
    "errors": [
        {
            "argument": "string",
            "reason": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "BadRequest",
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unauthorized",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 403 Forbidden

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Forbidden",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

application/json

{
    "id": "string",
    "type": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "NotFound",
    "type": "object",
    "required": [
        "id",
        "type"
    ],
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 409 Conflict

application/json

{
    "reason": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Conflict",
    "type": "object",
    "required": [
        "reason"
    ],
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

application/json

{
    "errorMessage": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "InternalServerError",
    "type": "object",
    "required": [
        "errorMessage"
    ],
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

application/json

{
    "status": null,
    "components": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "title": "Unhealthy",
    "type": "object",
    "required": [
        "status"
    ],
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        },
        "components": {
            "$ref": "#/components/schemas/Map_Health"
        }
    }
}

---

Schemas

Argument

Name	Type
argument	string
reason	string

AssetCheckResultEntry

Name	Type
assetId	string
originalFilename	string
results	Array<SingleFileCheckResultResponse>

AssetCheckResultResponse

Name	Type
results	Array<AssetCheckResultEntry>
summary	AssetCheckResultSummary

AssetCheckResultSummary

Name	Type
numberOfAssets	integer(int32)
numberOfChecksumMatches	integer(int32)
numberOfFiles	integer(int32)

AssetInfoResponse

Name	Type
checksumDerivative	string
checksumOriginal	string
duration	number(double)
fps	number(double)
height	integer(int32)
internalFilename	string
internalMimeType	string
originalFilename	string
originalInternalFilename	string
originalMimeType	string
width	integer(int32)

BadRequest

Name	Type
errors	Array<Argument>

Conflict

Name	Type
reason	string

DOWN

Forbidden

Name	Type
reason	string

Health

Name	Type
status	Status

InternalServerError

Name	Type
errorMessage	string

Map_Health

NotFound

Name	Type
id	string
type	string

ProjectResponse

Name	Type
id	string

SingleFileCheckResultResponse

Name	Type
checksumMatches	boolean
filename	string

Status

Type:

Unauthorized

Name	Type
reason	string

Unhealthy

Name	Type
components	Map_Health
status	Status

UP

UploadResponse

Name	Type
status	string

Security schemes

Name	Type	Scheme	Description
httpAuth	http	bearer