Post /data Access/v1/ {consumer Id} /data Jobs
POST a DataJobInfo to create a new data job.
consumerId
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.
{
"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
}
]
}
}
Job description based on the DME type specific dataProductionSchema.
A delivery schema identifier provided by a data producer during the data registration procedure.
Job successfully created.
{
"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
}
]
}
}
Job description based on the DME type specific dataProductionSchema.
A delivery schema identifier provided by a data producer during the data registration procedure.
Response Headers
The URI of the newly created data job.
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.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.
{
"type": "string",
"title": "string",
"status": 400,
"detail": "Required field 'counter_names' missing.",
"instance": "string"
}
A URI representing the type of the problem.
A short summary of the error.
The HTTP Response code associated with this error.
A detailed description of the error.
An optional URI of the instance involved in the problem.