Put Info Producer

Put Info Producer

Create or update one producer, allowing the producer to announce to the R1 environment that it is capable of producing one or more data-types and is able to accept jobs for those types.

Request
URI
PUT
https://{api_host}/dms/data-producer/v0alpha1/info-producers/{info_producer_id}
COPY
Path Parameters
string
info_producer_id
Required

The identifier of one producer.

Request Body
ProducerInfo of type(s) application/json
Required 
{
    "supported_info_types": [
        "pmhistory"
    ],
    "info_job_callback_url": "string"
}
array of string
supported_info_types
Required

A list of those data types that this producer plans to produce.

string
info_job_callback_url
Required

The callback URL by which the DMS will notify the producer of a new job.

Responses
200

Successfully updated one producer.

Operation doesn't return any data structure

201

Successfully created one producer.

Operation doesn't return any data structure

400

Unable to create or update producer: bad request body.

Returns ProblemDetails 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.


On This Page
Data Producer Operations
DELETE
Delete Info Producer
DELETE
Delete Info Type
PUT
Put Info Producer
PUT
Put Info Type