Skip to content

dsp-ingest-projects v0.5.0-23-gcbbe7a6-dirty

Servers

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

projects


GET /projects

Input parameters

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

Response 200 OK

[
    {
        "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

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

GET /projects/{shortcode}

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

{
    "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
{
    "required": [
        "id"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

GET /projects/{shortcode}/checksumreport

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

{
    "summary": {
        "numberOfAssets": 296,
        "numberOfFiles": 290,
        "numberOfChecksumMatches": 70
    },
    "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
{
    "required": [
        "summary"
    ],
    "type": "object",
    "properties": {
        "summary": {
            "$ref": "#/components/schemas/AssetCheckResultSummary"
        },
        "results": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/AssetCheckResultEntry"
            }
        }
    }
}

Response 400 Bad Request

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

assets


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

Input parameters

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

Response 200 OK

{
    "internalFilename": "string",
    "originalInternalFilename": "string",
    "originalFilename": "string",
    "checksumOriginal": "string",
    "checksumDerivative": "string",
    "width": 20,
    "height": 102,
    "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
{
    "required": [
        "internalFilename",
        "originalInternalFilename",
        "originalFilename",
        "checksumOriginal",
        "checksumDerivative"
    ],
    "type": "object",
    "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

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

bulk-ingest


POST /projects/{shortcode}/bulk-ingest

Description

Triggers an ingest on the project with the given shortcode. Currently only supports ingest of images. The files are expected to be in the tmp/<project_shortcode> directory.

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

{
    "id": "0001"
}
Schema of the response body
{
    "required": [
        "id"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

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.

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

{
    "id": "0001"
}
Schema of the response body
{
    "required": [
        "id"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

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

Description

Get the current result of the bulk ingest, may be incomplete. The result is a csv with the following structure: original,derivative

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

"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

Response 400 Bad Request

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

import/export


POST /projects/{shortcode}/export

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

"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

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

GET /projects/{shortcode}/import

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

"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

{
    "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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "type": "string"
        }
    }
}

Response 400 Bad Request

{
    "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
{
    "type": "object",
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Argument"
            }
        }
    }
}

Response 401 Unauthorized

{
    "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
{
    "required": [
        "reason"
    ],
    "type": "object",
    "properties": {
        "reason": {
            "type": "string"
        }
    }
}

Response 404 Not Found

{
    "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
{
    "required": [
        "id",
        "type"
    ],
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string"
        }
    }
}

Response 500 Internal Server Error

{
    "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
{
    "required": [
        "errorMessage"
    ],
    "type": "object",
    "properties": {
        "errorMessage": {
            "type": "string"
        }
    }
}

Response 503 Service Unavailable

{
    "status": null
}
⚠️ 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
{
    "required": [
        "status"
    ],
    "type": "object",
    "properties": {
        "status": {
            "$ref": "#/components/schemas/Status"
        }
    }
}

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>

DOWN

InternalServerError

Name Type
errorMessage string

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
status Status

UP

UploadResponse

Name Type
status string

Security schemes

Name Type Scheme Description
httpAuth http bearer