| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | string | An HTML page. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | string | The OpenAPI 3 specification as YAML. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| schemaName | URI-Path | string | minLength: 3 maxLength: 32 pattern: ^([a-z-_.0-9]+|\*{1})$ |
No | Name of the schema |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | string | result of the schema json |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| payload | POST-body | string | minLength: 1 maxLength: 4194304 |
No | Message content | |
| reference | POST-body | string | maxLength: 512 |
Yes | "" | Message reference |
| targetCustomer | POST-body | string | minLength: 1 maxLength: 15 pattern: ^([a-zA-Z0-9-_]+|\*{1})$ |
Yes | "*" | Customer ID of the target (receiver). |
| targetDepartment | POST-body | string | minLength: 1 maxLength: 15 pattern: ^([a-zA-Z0-9-_]+|\*{1})$ |
Yes | "*" | Department ID of the target (receiver). |
| waitForProcessing | POST-body | int | enum: [
0,
1
] |
Yes | 0 | 0/1-bool. If 0, a response is directly returned after validation and before processing and propagation. If 1, the response is returned once all processed messages are delivered to all consumers. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | string | If "waitForProcessing"=0, always returns a string "Validation passed." on success or one of the listed error codes otherwise. If "waitForProcessing"=1, always returns a string "Delivered: # out of #" on success or one of the listed error codes otherwise. |
| InvalidationException | 400 | Supplier specific invalidation. The message was rejected because it did not pass initial validation. See details for specifics. | |
| InvalidTargetException | 403 | Specified target (customer + department) is invalid: it does not exist or you are not authorized (yet) to send to this target. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| limit | URI-Query | int | minimum: 1 maximum: 100 |
Yes | 10 | Maximum amount of messages to return. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | ProcessedMessage[] | Array of Processed Messages. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| jobId | URI-Path | string | minLength: 26 maxLength: 26 |
No | Job ID as returned by POST /job. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Job: {jobId, customer, department, state, tsCreated, tsFinished, reference, failureReason, validation, callback: {state, attempts, tsSent, result}, messages: [{id, idArchive, type, tsProcessed, attempts, tsFinished, reference, customer, department, consumer, state, httpStatus, result}]}. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| content | POST-body | string | minLength: 1 maxLength: 4194304 |
No | Message content (Data Delivery Port V2 / importer format: {"schemaId":"","entities":[...]}). The user is taken from the API key. | |
| callback | POST-body | string | minLength: 1 maxLength: 1024 |
No | Public https URL (default port) that receives a POST with JSON {"jobId": "..."} when the job is finished. | |
| customer | POST-body | string | maxLength: 32 pattern: ^([a-zA-Z0-9-_]*)$ |
Yes | "" | Customer ID to submit for. Optional if the API key has a single (or default) customer/department. |
| department | POST-body | string | maxLength: 32 pattern: ^([a-zA-Z0-9-_]*)$ |
Yes | "" | Department ID to submit for. Optional if the API key has a single (or default) customer/department. |
| reference | POST-body | string | maxLength: 511 |
Yes | "" | Your own reference for this message. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Object {"jobId": string}. |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. | |
| InvalidationException | 400 | Supplier specific invalidation. The message was rejected because it did not pass initial validation. See details for specifics. | |
| InvalidTargetException | 403 | Specified target (customer + department) is invalid: it does not exist or you are not authorized (yet) to send to this target. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| format | URI-Query | string | enum: [
"KateAPI",
"InternalAPIMap",
"OpenAPI",
"Swagger"
] |
Yes | "KateAPI" | Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache. |
| openApiVersion | URI-Query | int | enum: [
2,
3
] |
Yes | 2 | Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation). |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | The API-documentation. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Object with 2 keys "active" and "deleted", each containing an array of Consumers. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Object with 2 keys "active" and "deleted", each containing an array of Suppliers. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | array | Array of {name, validatorClass, processorClass, keyId, legacyKeyActive, tenants: [{idCustomer, idDepartment, messages, lastReceived}], wildcardMessages}. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the Consumer to deactivate |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Deactivated Consumer. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidModelOperationException | 500 | An operation on a model was requested that was not valid/allowed. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the deactivated Consumer to reactivate |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Reactivated Consumer. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidModelOperationException | 500 | An operation on a model was requested that was not valid/allowed. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Object with numeric counts: invalidated, processed, delivered, undelivered, jobsFinished, callbacksSent, archived. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the Supplier to deactivate |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Deactivated Supplier. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidModelOperationException | 500 | An operation on a model was requested that was not valid/allowed. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the deactivated Supplier to delete |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | true | True. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidModelOperationException | 500 | An operation on a model was requested that was not valid/allowed. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the Supplier | ||
| keyId | POST-body | string | pattern: ^([0-9A-HJKMNP-TV-Z]{26})?$ |
No | keyId of the API key (26 chars), or empty to unlink |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Updated Supplier. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the Supplier | ||
| idUser | POST-body | int | minimum: 1 |
No | User the tokens of the key act as (sub); typically a technical user of the supplier. | |
| permissions | POST-body | string | format: json |
No | JSON string[]: permission ceiling of the key, e.g. ["red:import", ...] plus what red-write needs for the imported sets. import:job is always added. | |
| tokenLifetime | POST-body | int | minimum: 60 maximum: 86400 |
Yes | 86400 | Lifetime in seconds of the tokens; covers the retries of a job. |
| tenants | POST-body | string | format: json |
Yes | null | JSON [{idCustomer, idDepartment}] to grant instead of the tenants from the message history. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | {supplier, keyId, secret, grants, failedGrants}. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| DelegatedException | 500 | Another service invoked by this service using intra-service communication resulted in an error. See details for involved request and resulting error. HTTP status code is dynamically inherited, but defaults to 500. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the deactivated Supplier to reactivate |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Reactivated Supplier. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidModelOperationException | 500 | An operation on a model was requested that was not valid/allowed. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| name | POST-body | string | No | Exact name of the Supplier |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | object | Updated Supplier. |
| ModelNotFoundException | 404 | Instance of this model with provided ID could not be found. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |
| Parameter | Location | Type | Requirements | Optional | Default value | Description |
|---|---|---|---|---|---|---|
| payload | POST-body | string | format: json |
No | The data to map with J2JMapper. | |
| mapping | POST-body | string | format: json |
No | The mapping to be used by the J2JMapper. |
| Response | HTTP | Type | Description |
|---|---|---|---|
| Success | 200 | array | The output of the mapping as json. |
| MissingRequiredParameterException | 400 | The request is missing a required input parameter. See details for involved parameter. | |
| InvalidParameterException | 400 | The request has an invalid argument. See details for involved parameter and invalidation. | |
| AuthenticationFailedException | 401 | Authentication failed. Re-authenticate and retry. See error details for details. | |
| UnauthorizedException | 403 | Authorization for requested method rejected. See error details for details. |