Put Info Type Subscription

Put Info Type Subscription

Create or udpate a subscription that allows the requestor to receive notifications at the provided status_result_uri when any data or info types known to the DMS change their status.

Request
URI
PUT
https://{api_host}/dms/data-consumer/v0alpha1/info-type-subscriptions/{subscription_id}
COPY
Path Parameters
string
subscription_id
Required

The identifier of the subscription.

Request Body
InfoTypesSubscription of type(s) application/json
Required 
{
    "id": "string",
    "owner": "string",
    "status_result_uri": "string"
}
string
id
Optional

Unique Id identifying the subscription.

string
owner
Required

Name of the rapp or service subscribing for the info type notifications.

string
status_result_uri
Required

Callback URI that the DMS can invoke to notify the status of the info types.

Responses
200

Subscription successfully updated.

Operation doesn't return any data structure

201

Subscription successfully created.

Operation doesn't return any data structure

400

Malformed request body, subscription not created or updated.

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 Consumer Operations
DELETE
Delete Individual Job
DELETE
Delete Info Type Subscription
GET
Get Individual Job
GET
Get Info Type Consumer
GET
Get Info Type Subscription
GET
Get Info Type Subscriptions
GET
Get Job Ids
GET
Get Job Results
GET
Get Job Status
GET
List Info Types Consumer
PUT
Put Individual Info Job
PUT
Put Info Type Subscription