Batch Automation API Documentation version 1.0.8
https://api.syniverse.com/aba/v1
The purpose of this specification is to describe the Syniverse ABA Services API set. The purpose of this specification is to describe the Syniverse ABA Services API set.
executions
Returns a list of all the available executions.
get /executions
Returns a list of all the available executions.
Annotations
- tags:
["Executions"]
Query Parameters
- status: required (string)
Filters the results by the execution status.
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"executions": {
"type": "array",
"description": "List of executions.",
"items": {
"type": "object",
"description": "Execution.",
"properties": {
"id": {
"type": "string",
"description": "Execution ID."
},
"scheduleDetail": {
"type": "object",
"description": "The schedule associated with the execution.",
"properties": {
"id": {
"type": "string",
"description": "Schedule ID."
},
"jobId": {
"type": "string",
"description": "ID of the job associated with the schedule."
},
"name": {
"type": "string",
"description": "Schedule name."
},
"inputFileId": {
"type": "string",
"description": "Input file ID."
},
"fileRetentionDays": {
"type": "integer",
"description": "Defines for how many days the output and error files will be kept."
},
"scheduleRetentionDays": {
"type": "integer",
"description": "Defines for how many days the schedule will be kept after it's been executed."
},
"outputFileNamingExpression": {
"type": "string",
"description": "Expression for the output file name."
},
"outputFileFolder": {
"type": "string",
"description": "Folder where the output file will be saved."
},
"outputFileTag": {
"type": "string",
"description": "Output file tag."
},
"jobRuntimeContext": {
"type": "object",
"description": "This is a map of zero to many string fields as defined by the requirements of the related job.",
"properties": {
"field": {
"type": "string",
"description": "Job runtime context string field."
}
}
}
}
},
"status": {
"type": "string",
"description": "Execution status."
},
"statusReason": {
"type": "string",
"description": "Execution status reason."
},
"startTimestamp": {
"type": "integer",
"description": "Execution start timestamp."
},
"statusUpdateTimestamp": {
"type": "integer",
"description": "The timestamp of when the execution status was updated the last time."
},
"outputFileId": {
"type": "string",
"description": "ID of the output file."
},
"errorDetailFileId": {
"type": "string",
"description": "ID of the file containing the detailed list of errors that happened during the job execution."
},
"retryFileId": {
"type": "string",
"description": "ID of the file containing the records that failed during the job execution but can be retried."
},
"recordSuccessCount": {
"type": "integer",
"description": "Number of the successfully processed records."
},
"recordRetryCount": {
"type": "integer",
"description": "Number of the records that failed but can be retried."
},
"recordErrorCount": {
"type": "integer",
"description": "Number of the records that failed and can't be retried."
},
"outputFileURI": {
"type": "string",
"description": "URI of the output file."
},
"errorDetailFileURI": {
"type": "string",
"description": "URI of the error file."
},
"retryFileURI": {
"type": "string",
"description": "URI of the retry file."
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}jobs
Returns a list of jobs visible to the SDC Company ID.
Creates a new job.
get /jobs
Returns a list of jobs visible to the SDC Company ID.
Annotations
- tags:
["Jobs"]
Query Parameters
- runOrder: required (string)
Filters the results by the runOrder parameter. Accepted values: PARALLEL, SEQUENTIAL
- name: required (string)
Filters the results by job name.
- inputLayoutId: required (string)
Filters the results by the input layout ID.
- outputLayoutId: required (string)
Filters the results by the output layout ID.
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "array",
"description": "List of jobs.",
"items": {
"type": "object",
"description": "Job.",
"properties": {
"id": {
"type": "string",
"description": "Job ID."
},
"name": {
"type": "string",
"description": "Job name."
},
"groupId": {
"type": "string",
"description": "Job group ID."
},
"description": {
"type": "string",
"description": "Job description."
},
"inputLayoutId": {
"type": "string",
"description": "Input layout ID."
},
"outputLayoutId": {
"type": "string",
"description": "Output layout ID. Leave blank if the job will not produce an output file."
},
"maxInputFileSize": {
"type": "number",
"description": "Maximum size of the input file in bytes."
},
"onStart": {
"type": "array",
"items": {
"type": "object",
"description": "Steps to execute when the job starts.",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onCompletion": {
"type": "array",
"items": {
"type": "object",
"description": "Steps to execute when the job ends.",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"forEachRecord": {
"type": "array",
"items": {
"type": "object",
"description": "Steps to execute for each data record except the header and trailer.",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onEndChunk": {
"type": "array",
"items": {
"type": "object",
"description": "Steps to execute at the end of each Spring Batch chunk.",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onPostProcessing": {
"type": "array",
"items": {
"type": "object",
"description": "Steps to execute asychronously after the job has successfully completed.",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}post /jobs
Creates a new job.
Annotations
- tags:
["Jobs"]
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"job": {
"type": "object",
"description": "Job to create.",
"properties": {
"id": {
"type": "string",
"description": "Job ID."
},
"name": {
"type": "string",
"description": "Job name."
},
"groupId": {
"type": "string",
"description": "Job group ID."
},
"description": {
"type": "string",
"description": "Job description."
},
"inputLayoutId": {
"type": "string",
"description": "Input layout ID."
},
"outputLayoutId": {
"type": "string",
"description": "Output layout ID. Leave blank if the job will not produce an output file."
},
"maxInputFileSize": {
"type": "number",
"description": "Maximum size of the input file in bytes."
},
"onStart": {
"type": "array",
"description": "Steps to execute when the job starts.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"onCompletion": {
"type": "array",
"description": "Steps to execute when the job ends.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"forEachRecord": {
"type": "array",
"description": "Steps to execute for each data record except the header and trailer.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"onEndChunk": {
"type": "array",
"description": "Steps to execute at the end of each Spring Batch chunk.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"onPostProcessing": {
"type": "array",
"description": "Steps to execute asychronously after the job has successfully completed.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"job": {
"type": "object",
"description": "The created job.",
"properties": {
"id": {
"type": "string",
"description": "Job ID."
},
"name": {
"type": "string",
"description": "Job name."
},
"groupId": {
"type": "string",
"description": "Job group ID."
},
"description": {
"type": "string",
"description": "Job description."
},
"inputLayoutId": {
"type": "string",
"description": "Input layout ID."
},
"outputLayoutId": {
"type": "string",
"description": "Output layout ID. Leave blank if the job will not produce an output file."
},
"maxInputFileSize": {
"type": "number",
"description": "Maximum size of the input file in bytes."
},
"onStart": {
"type": "array",
"description": "Steps to execute when the job starts.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"onCompletion": {
"type": "array",
"description": "Steps to execute when the job ends.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"forEachRecord": {
"type": "array",
"description": "Steps to execute for each data record except the header and trailer.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"onEndChunk": {
"type": "array",
"description": "Steps to execute at the end of each Spring Batch chunk.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
},
"onPostProcessing": {
"type": "array",
"description": "Steps to execute asychronously after the job has successfully completed.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}Returns the job for a given ID.
Update an existing job.
get /jobs/{JOB_ID}
Returns the job for a given ID.
URI Parameters
- JOB_ID: required (string)
This is the unique identifier of the JOB_ID resource.
Annotations
- tags:
["Jobs"]
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"description": "The requested job.",
"properties": {
"id": {
"type": "string",
"description": "Job ID."
},
"name": {
"type": "string",
"description": "Job name."
},
"groupId": {
"type": "string",
"description": "Job group ID."
},
"description": {
"type": "string",
"description": "Job description."
},
"inputLayoutId": {
"type": "string",
"description": "Input layout ID."
},
"outputLayoutId": {
"type": "string",
"description": "Output layout ID. Leave blank if the job will not produce an output file."
},
"maxInputFileSize": {
"type": "number",
"description": "Maximum size of the input file in bytes."
},
"onStart": {
"type": "array",
"description": "Steps to execute when the job starts.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onCompletion": {
"type": "array",
"description": "Steps to execute when the job ends.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"forEachRecord": {
"type": "array",
"description": "Steps to execute for each data record except the header and trailer.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onEndChunk": {
"type": "array",
"description": "Steps to execute at the end of each Spring Batch chunk.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onPostProcessing": {
"type": "array",
"description": "Steps to execute asychronously after the job has successfully completed.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}put /jobs/{JOB_ID}
Update an existing job.
URI Parameters
- JOB_ID: required (string)
This is the unique identifier of the JOB_ID resource.
Annotations
- tags:
["Jobs"]
Body
Media type: multipart/form-data
Type: object
Properties- job: (string)
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"description": "The updated job.",
"properties": {
"id": {
"type": "string",
"description": "Job ID."
},
"name": {
"type": "string",
"description": "Job name."
},
"groupId": {
"type": "string",
"description": "Job group ID."
},
"description": {
"type": "string",
"description": "Job description."
},
"inputLayoutId": {
"type": "string",
"description": "Input layout ID."
},
"outputLayoutId": {
"type": "string",
"description": "Output layout ID. Leave blank if the job will not produce an output file."
},
"maxInputFileSize": {
"type": "number",
"description": "Maximum size of the input file in bytes."
},
"onStart": {
"type": "array",
"description": "Steps to execute when the job starts.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onCompletion": {
"type": "array",
"description": "Steps to execute when the job ends.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"forEachRecord": {
"type": "array",
"description": "Steps to execute for each data record except the header and trailer.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onEndChunk": {
"type": "array",
"description": "Steps to execute at the end of each Spring Batch chunk.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
},
"onPostProcessing": {
"type": "array",
"description": "Steps to execute asychronously after the job has successfully completed.",
"items": {
"type": "object",
"properties": {
"stepId": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"busName": {
"type": "string"
},
"literalFormat": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}layouts
Returns a list of file layouts visible to the SDC company ID.
Creates a new layout.
get /layouts
Returns a list of file layouts visible to the SDC company ID.
Annotations
- tags:
["Layouts"]
Query Parameters
- name: required (string)
Filters the results by the layout name.
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "array",
"description": "List of layouts.",
"items": {
"type": "object",
"description": "Layout.",
"properties": {
"id": {
"type": "string",
"description": "Layout ID."
},
"name": {
"type": "string",
"description": "Layout name."
},
"groupId": {
"type": "string",
"description": "Layout group ID."
},
"fieldDelimiter": {
"type": "string",
"description": "A character, separating the fields in a single record."
},
"recordLayout": {
"type": "array",
"description": "Record layout. Represents a list of fields in a single record.",
"items": {
"type": "object",
"description": "Fields list.",
"properties": {
"name": {
"type": "string",
"description": "Field name."
},
"variableName": {
"type": "string",
"description": "Field variable name."
},
"type": {
"type": "string",
"description": "Field type. The accepted values are: TEXT, INTEGER, DOUBLE, LONG, TIMESTAMP, TIMESTAMPJ8, BOOLEAN."
},
"required": {
"type": "boolean",
"description": "Indicates whether the field is required."
},
"suppressDelimiterOnNull": {
"type": "boolean",
"description": "If true, do not add a delimiter if the field's value is null."
},
"writeRaw": {
"type": "boolean",
"description": "If true, do not auto-escape the layout's delimiter character within this field."
},
"format": {
"type": [
"null",
"string"
],
"description": "Date format for the fields of type TIMESTAMP and TIMESTAMPJ8."
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}post /layouts
Creates a new layout.
Annotations
- tags:
["Layouts"]
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"layout": {
"type": "object",
"description": "Layout to create.",
"properties": {
"name": {
"type": "string",
"description": "Layout name."
},
"groupId": {
"type": "string",
"description": "Layout group ID."
},
"fieldDelimiter": {
"type": "string",
"description": "A character, separating the fields in a single record."
},
"recordLayout": {
"type": "array",
"description": "Record layout. Represents a list of fields in a single record.",
"items": {
"type": "object",
"description": "Fields list.",
"properties": {
"name": {
"type": "string",
"description": "Field name."
},
"variableName": {
"type": "string",
"description": "Field variable name."
},
"type": {
"type": "string",
"description": "Field type. The accepted values are: TEXT, INTEGER, DOUBLE, LONG, TIMESTAMP, TIMESTAMPJ8, BOOLEAN."
},
"required": {
"type": "boolean",
"description": "Indicates whether the field is required."
},
"suppressDelimiterOnNull": {
"type": "boolean",
"description": "If true, do not add a delimiter if the field's value is null."
},
"writeRaw": {
"type": "boolean",
"description": "If true, do not auto-escape the layout's delimiter character within this field."
},
"format": {
"type": [
"null",
"string"
],
"description": "Date format for the fields of type TIMESTAMP and TIMESTAMPJ8."
}
}
}
}
}
}
}
}HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"layout": {
"type": "object",
"description": "The created layout.",
"properties": {
"id": {
"type": "string",
"description": "Layout ID."
},
"name": {
"type": "string",
"description": "Layout name."
},
"groupId": {
"type": "string",
"description": "Layout group ID."
},
"fieldDelimiter": {
"type": "string",
"description": "A character, separating the fields in a single record."
},
"recordLayout": {
"type": "array",
"description": "Record layout. Represents a list of fields in a single record.",
"items": {
"type": "object",
"description": "Fields list.",
"properties": {
"name": {
"type": "string",
"description": "Field name."
},
"variableName": {
"type": "string",
"description": "Field variable name."
},
"type": {
"type": "string",
"description": "Field type. The accepted values are: TEXT, INTEGER, DOUBLE, LONG, TIMESTAMP, TIMESTAMPJ8, BOOLEAN."
},
"required": {
"type": "boolean",
"description": "Indicates whether the field is required."
},
"suppressDelimiterOnNull": {
"type": "boolean",
"description": "If true, do not add a delimiter if the field's value is null."
},
"writeRaw": {
"type": "boolean",
"description": "If true, do not auto-escape the layout's delimiter character within this field."
},
"format": {
"type": [
"null",
"string"
],
"description": "Date format for the fields of type TIMESTAMP and TIMESTAMPJ8."
}
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}Returns the layout for the given layout ID.
Update an existing layout.
get /layouts/{LAYOUT_ID}
Returns the layout for the given layout ID.
URI Parameters
- LAYOUT_ID: required (string)
This is the unique identifier of the LAYOUT_ID resource.
Annotations
- tags:
["Layouts"]
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"description": "The requested layout.",
"properties": {
"layout": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Layout ID."
},
"name": {
"type": "string",
"description": "Layout name."
},
"groupId": {
"type": "string",
"description": "Layout group ID."
},
"fieldDelimiter": {
"type": "string",
"description": "A character, separating the fields in a single record."
},
"recordLayout": {
"type": "array",
"description": "Record layout. Represents a list of fields in a single record.",
"items": {
"type": "object",
"description": "Fields list.",
"properties": {
"name": {
"type": "string",
"description": "Field name."
},
"variableName": {
"type": "string",
"description": "Field variable name."
},
"type": {
"type": "string",
"description": "Field type. The accepted values are: TEXT, INTEGER, DOUBLE, LONG, TIMESTAMP, TIMESTAMPJ8, BOOLEAN."
},
"required": {
"type": "boolean",
"description": "Indicates whether the field is required."
},
"suppressDelimiterOnNull": {
"type": "boolean",
"description": "If true, do not add a delimiter if the field's value is null."
},
"writeRaw": {
"type": "boolean",
"description": "If true, do not auto-escape the layout's delimiter character within this field."
},
"format": {
"type": [
"null",
"string"
],
"description": "Date format for the fields of type TIMESTAMP and TIMESTAMPJ8."
}
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}put /layouts/{LAYOUT_ID}
Update an existing layout.
URI Parameters
- LAYOUT_ID: required (string)
This is the unique identifier of the LAYOUT_ID resource.
Annotations
- tags:
["Layouts"]
Body
Media type: multipart/form-data
Type: object
Properties- layout: (string)
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"layout": {
"type": "object",
"description": "The updated layout.",
"properties": {
"id": {
"type": "string",
"description": "Layout ID."
},
"name": {
"type": "string",
"description": "Layout name."
},
"groupId": {
"type": "string",
"description": "Layout group ID."
},
"fieldDelimiter": {
"type": "string",
"description": "A character, separating the fields in a single record."
},
"recordLayout": {
"type": "array",
"description": "Record layout. Represents a list of fields in a single record.",
"items": {
"type": "object",
"description": "Fields list.",
"properties": {
"name": {
"type": "string",
"description": "Field name."
},
"variableName": {
"type": "string",
"description": "Field variable name."
},
"type": {
"type": "string",
"description": "Field type. The accepted values are: TEXT, INTEGER, DOUBLE, LONG, TIMESTAMP, TIMESTAMPJ8, BOOLEAN."
},
"required": {
"type": "boolean",
"description": "Indicates whether the field is required."
},
"suppressDelimiterOnNull": {
"type": "boolean",
"description": "If true, do not add a delimiter if the field's value is null."
},
"writeRaw": {
"type": "boolean",
"description": "If true, do not auto-escape the layout's delimiter character within this field."
},
"format": {
"type": [
"null",
"string"
],
"description": "Date format for the fields of type TIMESTAMP and TIMESTAMPJ8."
}
}
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}schedules
Returns a list of schedules visible to the SDC company ID.
Creates a new schedule, which can be a one-time or recurring. Only the job type of one-time is included in MVP scope.
get /schedules
Returns a list of schedules visible to the SDC company ID.
Annotations
- tags:
["Schedules"]
Query Parameters
- jobId: required (string)
Filters the results by the ID of the job associated with the schedule.
- name: required (string)
Filters the results by the schedule name.
- inputFileId: required (string)
Filters the results by the input file ID.
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"schedules": {
"type": "array",
"description": "List of schedules.",
"items": {
"type": "object",
"description": "Schedule.",
"properties": {
"id": {
"type": "string",
"description": "Schedule ID."
},
"jobId": {
"type": "string",
"description": "ID of the job associated with the schedule."
},
"name": {
"type": "string",
"description": "Schedule name"
},
"inputFileId": {
"type": "string",
"description": "Input file ID."
},
"fileRetentionDays": {
"type": "integer",
"description": "Defines for how many days the output and error files will be kept."
},
"scheduleRetentionDays": {
"type": "integer",
"description": "Defines for how many days the schedule will be kept after it's been executed."
},
"outputFileNamingExpression": {
"type": "string",
"description": "Expression for the output file name."
},
"outputFileFolder": {
"type": "string",
"description": "Folder where the output file will be saved."
},
"outputFileTag": {
"type": [
"null",
"string"
],
"description": "Output file tag."
},
"jobRuntimeContext": {
"type": "object",
"description": "This is a map of zero to many string fields as defined by the requirements of the related job."
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}post /schedules
Creates a new schedule, which can be a one-time or recurring. Only the job type of one-time is included in MVP scope.
Annotations
- tags:
["Schedules"]
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"description": "Schedule to create.",
"properties": {
"jobId": {
"type": "string",
"description": "ID of the job associated with the schedule."
},
"name": {
"type": "string",
"description": "Schedule name"
},
"inputFileId": {
"type": "string",
"description": "Input file ID."
},
"fileRetentionDays": {
"type": "integer",
"description": "Defines for how many days the output and error files will be kept."
},
"scheduleRetentionDays": {
"type": "integer",
"description": "Defines for how many days the schedule will be kept after it's been executed."
},
"outputFileNamingExpression": {
"type": "string",
"description": "Expression for the output file name."
},
"outputFileFolder": {
"type": "string",
"description": "Folder where the output file will be saved."
},
"jobRuntimeContext": {
"type": "object",
"description": "This is a map of zero to many string fields as defined by the requirements of the related job."
}
}
}
}
}HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"description": "The created schedule.",
"properties": {
"id": {
"type": "string",
"description": "Schedule ID."
},
"jobId": {
"type": "string",
"description": "ID of the job associated with the schedule."
},
"name": {
"type": "string",
"description": "Schedule name"
},
"inputFileId": {
"type": "string",
"description": "Input file ID."
},
"fileRetentionDays": {
"type": "integer",
"description": "Defines for how many days the output and error files will be kept."
},
"scheduleRetentionDays": {
"type": "integer",
"description": "Defines for how many days the schedule will be kept after it's been executed."
},
"outputFileNamingExpression": {
"type": "string",
"description": "Expression for the output file name."
},
"outputFileFolder": {
"type": "string",
"description": "Folder where the output file will be saved."
},
"outputFileTag": {
"type": [
"null",
"string"
],
"description": "Output file tag."
},
"jobRuntimeContext": {
"type": "object",
"description": "This is a map of zero to many string fields as defined by the requirements of the related job."
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}Returns a list of executions for the given schedule identifier.
get /schedules/{schedule_id}/executions
Returns a list of executions for the given schedule identifier.
URI Parameters
- schedule_id: required (string)
Annotations
- tags:
["Schedules"]
Query Parameters
- status: required (string)
Filter
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"executions": {
"type": "array",
"description": "List of executions of the specified schedule.",
"items": {
"type": "object",
"description": "Execution.",
"properties": {
"id": {
"type": "string",
"description": "Execution ID."
},
"scheduleDetail": {
"type": "object",
"description": "The related schedule.",
"properties": {
"id": {
"type": "string",
"description": "Schedule ID."
},
"jobId": {
"type": "string",
"description": "ID of the job associated with the schedule."
},
"name": {
"type": "string",
"description": "Schedule name."
},
"inputFileId": {
"type": "string",
"description": "Input file ID."
},
"fileRetentionDays": {
"type": "integer",
"description": "Defines for how many days the output and error files will be kept."
},
"scheduleRetentionDays": {
"type": "integer",
"description": "Defines for how many days the schedule will be kept after it's been executed."
},
"outputFileNamingExpression": {
"type": "string",
"description": "Expression for the output file name."
},
"outputFileFolder": {
"type": "string",
"description": "Folder where the output file will be saved."
},
"outputFileTag": {
"type": [
"null",
"string"
],
"description": "Output file tag."
},
"jobRuntimeContext": {
"type": "object",
"description": "This is a map of zero to many string fields as defined by the requirements of the related job."
}
}
},
"status": {
"type": "string",
"description": "Execution status."
},
"statusReason": {
"type": "string",
"description": "Execution status reason."
},
"startTimestamp": {
"type": "number",
"description": "Execution start timestamp."
},
"statusUpdateTimestamp": {
"type": "number",
"description": "The timestamp of when the execution status was updated the last time."
},
"outputFileId": {
"type": [
"null",
"string"
],
"description": "ID of the output file."
},
"errorDetailFileId": {
"type": [
"null",
"string"
],
"description": "ID of the file containing the detailed list of errors that happened during the job execution."
},
"retryFileId": {
"type": [
"null",
"string"
],
"description": "ID of the file containing the records that failed during the job execution but can be retried."
},
"recordSuccessCount": {
"type": "number",
"description": "Number of the successfully processed records."
},
"recordRetryCount": {
"type": "number",
"description": "Number of the records that failed but can be retried."
},
"recordErrorCount": {
"type": "number",
"description": "Number of the records that failed and can't be retried."
},
"outputFileURI": {
"type": [
"null",
"string"
],
"description": "URI of the output file."
},
"errorDetailFileURI": {
"type": [
"null",
"string"
],
"description": "URI of the error file."
},
"retryFileURI": {
"type": [
"null",
"string"
],
"description": "URI of the retry file."
}
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}Requests an immediate, unrecoverable termination of a running Execution.
post /schedules/{schedule_id}/executions/{execution_id}/stop
Requests an immediate, unrecoverable termination of a running Execution.
URI Parameters
- schedule_id: required (string)
- execution_id: required (string)
Annotations
- tags:
["Schedules"]
Body
Media type: application/json
Type: object
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Response message."
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}Returns the execution for the given schedule and execution ID.
get /schedules/{schedule_id}/executions/{EXEC_ID}
Returns the execution for the given schedule and execution ID.
URI Parameters
- schedule_id: required (string)
- EXEC_ID: required (string)
This is the unique identifier of the EXEC_ID resource.
Annotations
- tags:
["Schedules"]
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"description": "The requested execution.",
"properties": {
"execution": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Execution ID."
},
"scheduleDetail": {
"type": "object",
"description": "The related schedule.",
"properties": {
"id": {
"type": "string",
"description": "Schedule ID."
},
"jobId": {
"type": "string",
"description": "ID of the job associated with the schedule."
},
"name": {
"type": "string",
"description": "Schedule name."
},
"inputFileId": {
"type": "string",
"description": "Input file ID."
},
"fileRetentionDays": {
"type": "integer",
"description": "Defines for how many days the output and error files will be kept."
},
"scheduleRetentionDays": {
"type": "integer",
"description": "Defines for how many days the schedule will be kept after it's been executed."
},
"outputFileNamingExpression": {
"type": "string",
"description": "Expression for the output file name."
},
"outputFileFolder": {
"type": "string",
"description": "Folder where the output file will be saved."
},
"outputFileTag": {
"type": [
"null",
"string"
],
"description": "Output file tag."
},
"jobRuntimeContext": {
"type": "object",
"description": "This is a map of zero to many string fields as defined by the requirements of the related job."
}
}
},
"status": {
"type": "string",
"description": "Execution status."
},
"statusReason": {
"type": "string",
"description": "Execution status reason."
},
"startTimestamp": {
"type": "number",
"description": "Execution start timestamp."
},
"statusUpdateTimestamp": {
"type": "number",
"description": "The timestamp of when the execution status was updated the last time."
},
"outputFileId": {
"type": [
"null",
"string"
],
"description": "ID of the output file."
},
"errorDetailFileId": {
"type": [
"null",
"string"
],
"description": "ID of the file containing the detailed list of errors that happened during the job execution."
},
"retryFileId": {
"type": [
"null",
"string"
],
"description": "ID of the file containing the records that failed during the job execution but can be retried."
},
"recordSuccessCount": {
"type": "number",
"description": "Number of the successfully processed records."
},
"recordRetryCount": {
"type": "number",
"description": "Number of the records that failed but can be retried."
},
"recordErrorCount": {
"type": "number",
"description": "Number of the records that failed and can't be retried."
},
"outputFileURI": {
"type": [
"null",
"string"
],
"description": "URI of the output file."
},
"errorDetailFileURI": {
"type": [
"null",
"string"
],
"description": "URI of the error file."
},
"retryFileURI": {
"type": [
"null",
"string"
],
"description": "URI of the retry file."
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}Returns the schedule for the given schedule ID.
get /schedules/{SCHEDULE_ID}
Returns the schedule for the given schedule ID.
URI Parameters
- SCHEDULE_ID: required (string)
This is the unique identifier of the SCHEDULE_ID resource.
Annotations
- tags:
["Schedules"]
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"description": "The requested schedule.",
"properties": {
"schedule": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Schedule ID."
},
"jobId": {
"type": "string",
"description": "ID of the job associated with the schedule."
},
"name": {
"type": "string",
"description": "Schedule name"
},
"inputFileId": {
"type": "string",
"description": "Input file ID."
},
"fileRetentionDays": {
"type": "integer",
"description": "Defines for how many days the output and error files will be kept."
},
"scheduleRetentionDays": {
"type": "integer",
"description": "Defines for how many days the schedule will be kept after it's been executed."
},
"outputFileNamingExpression": {
"type": "string",
"description": "Expression for the output file name."
},
"outputFileFolder": {
"type": "string",
"description": "Folder where the output file will be saved."
},
"outputFileTag": {
"type": [
"null",
"string"
],
"description": "Output file tag."
},
"jobRuntimeContext": {
"type": "object",
"description": "This is a map of zero to many string fields as defined by the requirements of the related job."
}
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}steps
Returns a list of steps visible to the SDC company ID.
get /steps
Returns a list of steps visible to the SDC company ID.
Annotations
- tags:
["Steps"]
Query Parameters
- name: required (string)
Filters the results by the step name.
- jobStepReferenceName: required (string)
Filters the results by the step's dynamic source reference in execution context.
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "array",
"description": "List of steps.",
"items": {
"type": "object",
"description": "Step.",
"properties": {
"id": {
"type": "string",
"description": "Step ID."
},
"name": {
"type": "string",
"description": "Step name."
},
"groupId": {
"type": "string",
"description": "Group ID."
},
"parameters": {
"type": "array",
"description": "Step parameters. These can be sourced from input fields, static values, system values (e.g., \"system-time\") or prior step results.",
"items": {
"type": "object",
"description": "Step parameter.",
"properties": {
"name": {
"type": "string",
"description": "Parameter name."
},
"type": {
"type": "string",
"description": "Parameter type."
},
"required": {
"type": "boolean",
"description": "Whether the parameter is required."
},
"description": {
"type": "string",
"description": "Parameter description."
}
}
}
},
"result": {
"type": "array",
"description": "The resulting data that is mapped into referenceable fields.",
"items": {
"type": "object",
"description": "Step result.",
"properties": {
"name": {
"type": "string",
"description": "Result name."
},
"type": {
"type": "string",
"description": "Result type."
},
"description": {
"type": "string",
"description": "Result description."
},
"required": {
"type": "boolean",
"description": "Whether the result is required."
}
}
}
},
"jobStepReferenceName": {
"type": "string",
"description": "Job step reference name. Used as dynamic source reference for this step in execution context."
}
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}Returns the step for the given step ID.
get /steps/{STEP_ID}
Returns the step for the given step ID.
URI Parameters
- STEP_ID: required (string)
This is the unique identifier of the STEP_ID resource.
Annotations
- tags:
["Steps"]
HTTP status code 200
Successful operation.
Body
Media type: application/json
Type:
{
"type": "object",
"description": "The requested step.",
"properties": {
"id": {
"type": "string",
"description": "Step ID."
},
"name": {
"type": "string",
"description": "Step name."
},
"groupId": {
"type": "string",
"description": "Group ID."
},
"parameters": {
"type": "array",
"description": "Step parameters. These can be sourced from input fields, static values, system values (e.g., \"system-time\") or prior step results.",
"items": {
"type": "object",
"description": "Step parameter.",
"properties": {
"name": {
"type": "string",
"description": "Parameter name."
},
"type": {
"type": "string",
"description": "Parameter type."
},
"required": {
"type": "boolean",
"description": "Whether the parameter is required."
},
"description": {
"type": "string",
"description": "Parameter description."
}
}
}
},
"result": {
"type": "array",
"description": "The resulting data that is mapped into referenceable fields.",
"items": {
"type": "object",
"description": "Step result.",
"properties": {
"name": {
"type": "string",
"description": "Result name."
},
"type": {
"type": "string",
"description": "Result type."
},
"description": {
"type": "string",
"description": "Result description."
},
"required": {
"type": "boolean",
"description": "Whether the result is required."
}
}
}
},
"jobStepReferenceName": {
"type": "string",
"description": "Job step reference name. Used as dynamic source reference for this step in execution context."
}
}
}HTTP status code 400
Bad Request. The request could not be understood by the server.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 401
Unauthorized. The request requires user authentication.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 402
Payment Required.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 403
Forbidden. The user does not have permission to access the specified resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 409
Conflict. The request could not be completed due to a conflict with the current state of the target resource.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 412
Precondition Failed. The server does not meet one of the preconditions that the requester put on the request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 429
Too Many Requests. The user has sent too many requests in a given amount of time.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}HTTP status code 500
Server Error. An error has been encountered while processing this request.
Possible Error Codes:
Body
Media type: application/json
Type:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Error Response",
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Error code."
},
"error_description": {
"type": "string",
"description": "Error description."
}
}
}