Put Info Type

Put Info Type

Ensure that the info or data type named by info_type_id is registered in the system as a valid data-type for which rApp consumers may make requests.

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

The name of one data type.

Request Body
DataTypeProducer of type(s) application/json
Required 
{
    "info_type_information": {
        "foo": "bar"
    },
    "info_job_data_schema": {
        "foo": "bar"
    },
    "collectable": false,
    "subscription": false
}
object
info_type_information
Optional

Type specific information for this information type that does not fit in the info_job_data_schema.

object
info_job_data_schema
Required

A JSON schema describing how job data is queried and delivered.

boolean
collectable
Optional

If true, consumers of this type will have their requests processed through dms data-collection which may engage a caching mechanism if the same job has run before.

boolean
subscription
Optional

If true, consumers of this type will typically register one job and then receive mulitiple notifications from the long run job. Each notification will happen when more data is available. The consumer should be sure to delete the job when no longer needed.

Responses
200

Data type successfully updated.

Operation doesn't return any data structure

201

Data type successfully created.

Operation doesn't return any data structure

400

Data type request body malformed.

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