Post /data Access/v1/ {consumer Id} /data Jobs

Post /data Access/v1/ {consumer Id} /data Jobs

POST a DataJobInfo to create a new data job.

Request
URI
POST
https://{api_host}/dms/data-access/v1/{consumerId}/dataJobs
COPY
Path Parameters
string
consumerId
Required

consumerId

Header Parameters
string
Version
Optional

If provided in a request, the value of the header is a string signalling the desired version of the API to be used in handling the request. If the provided version is not available, a 406 Not Acceptable response will be sent. If no Version header is provided, the latest available version will be used. This mechanism allows a user-agent to request a specfic version of the API when multiple versions are available.


Request Body
DataJobInfo of type(s) application/json
Required
{
    "dataDelivery": "string",
    "dataTypeId": "string",
    "dataDeliveryMechanism": {
        "deliveryMethod": "string",
        "kafkaDeliveryConfiguration": {
            "numPartitions": 0,
            "cleanUpPolicy": "string",
            "compressionType": "string",
            "retentionBytes": 0,
            "retentionMs": 0
        }
    },
    "dataDeliverySchemaId": "string",
    "pullDeliveryDetailsHttp": {
        "dataPullUri": "string"
    },
    "dataAvailabilityNotificationUri": "string",
    "pushDeliveryDetailsHttp": {
        "dataPushUri": "string"
    },
    "streamingConfigurationKafka": {
        "topicName": "string",
        "kafkaBootstrapServers": [
            {
                "hostname": "string",
                "portAddress": 0
            }
        ]
    }
}
dataDelivery
Required

dataDelivery

dataTypeId
Required

dataTypeId

object
productionJobDefinition
Required

Job description based on the DME type specific dataProductionSchema.

dataDeliveryMechanism
Required

dataDeliveryMechanism

string
dataDeliverySchemaId
Required

A delivery schema identifier provided by a data producer during the data registration procedure.

pullDeliveryDetailsHttp
Optional

pullDeliveryDetailsHttp

dataAvailabilityNotificationUri
Optional

dataAvailabilityNotificationUri

pushDeliveryDetailsHttp
Optional

pushDeliveryDetailsHttp

streamingConfigurationKafka
Optional

streamingConfigurationKafka

Responses
201

Job successfully created.

Returns DataJobInfo of type(s) application/json
{
    "dataDelivery": "string",
    "dataTypeId": "string",
    "dataDeliveryMechanism": {
        "deliveryMethod": "string",
        "kafkaDeliveryConfiguration": {
            "numPartitions": 0,
            "cleanUpPolicy": "string",
            "compressionType": "string",
            "retentionBytes": 0,
            "retentionMs": 0
        }
    },
    "dataDeliverySchemaId": "string",
    "pullDeliveryDetailsHttp": {
        "dataPullUri": "string"
    },
    "dataAvailabilityNotificationUri": "string",
    "pushDeliveryDetailsHttp": {
        "dataPushUri": "string"
    },
    "streamingConfigurationKafka": {
        "topicName": "string",
        "kafkaBootstrapServers": [
            {
                "hostname": "string",
                "portAddress": 0
            }
        ]
    }
}
dataDelivery
Required

dataDelivery

dataTypeId
Required

dataTypeId

object
productionJobDefinition
Required

Job description based on the DME type specific dataProductionSchema.

dataDeliveryMechanism
Required

dataDeliveryMechanism

string
dataDeliverySchemaId
Required

A delivery schema identifier provided by a data producer during the data registration procedure.

pullDeliveryDetailsHttp
Optional

pullDeliveryDetailsHttp

dataAvailabilityNotificationUri
Optional

dataAvailabilityNotificationUri

pushDeliveryDetailsHttp
Optional

pushDeliveryDetailsHttp

streamingConfigurationKafka
Optional

streamingConfigurationKafka

Response Headers

string
Location

The URI of the newly created data job.

string
Version

The Version header in a response indicates the version of the API used to handle this request-response pair, in an API which has the potential to support multiple versions. Different versions may be requested using a Version header in a request.


400
Returns BadRequest of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


401
Returns Unauthorized of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


403
Returns Forbidden of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


404
Returns NotFound of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


406
Returns Unacceptable of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


409
Returns Conflict of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


415
Returns Unsupported of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


500
Returns ServerError of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.


503
Returns ServiceUnavailable of type(s) application/problem+json
{
    "type": "string",
    "title": "string",
    "status": 400,
    "detail": "Required field 'counter_names' missing.",
    "instance": "string"
}
string
type
Optional

A URI representing the type of the problem.

string
title
Required

A short summary of the error.

number
status
Required

The HTTP Response code associated with this error.

string
detail
Required

A detailed description of the error.

string
instance
Optional

An optional URI of the instance involved in the problem.