[{"label":"Latest (0.1.1)","version":"latest"}]
cric-r1

Put Info Type

Description

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

Request

URL

URL


put
https://{api_host}/dms/data-producer/v0alpha1/info-types/{info_type_id}
Copy

Path Parameters

Path Parameters

string
info_type_id Required

The name of one data type.


Request Body

Request Body

DataTypeProducer of mimetype application/json Required
{
    "info_job_data_schema": {
        "foo": "bar"
    }
}
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.


object
info_type_information Optional

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

Response

Response

200 OK

Data type successfully updated.


201 Created

Data type successfully created.

Errors

Errors

400

Data type request body malformed.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"info_job_data_schema":{"foo":"bar"},"info_type_information":{"foo":"bar"}}' https://{api_host}/dms/data-producer/v0alpha1/info-types/{info_type_id}


[{"label":"Latest (0.1.1)","version":"latest"}]
cric-r1
Feedback

Was this page helpful?