Data Sources - Update a Data Source

Update a Data Source

Updates a Data Source. The updateable fields are the audience, subject, nonce, url and tokenLifetimeMinutes. You can update the status from active to disabled only when providing an errorMessage that may be shown to the customer admin in Control Hub. Tokens must be regularly updated before their expiration to maintain system uptime.

PUT/v1/dataSources/{dataSourceId}

URI Parameters

dataSourceId

stringrequired

The unique identifier for the data source.

Body Parameters

schemaId

string

The schema id used for the data exchange.

url

string

The URL of the endpoint where Webex will send the data.

audience

string

The audience field in the JWT token. Usually, the DAPs app name.

subject

string

The subject field in the JWT token. Usually, an indication of the app's function

nonce

string

Unique nonce used in the encryption of the JWT token.

tokenLifetimeMinutes

number

The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration. Must be equal or less to 1440.

status

string

The status of the Data Source; active or disabled.

errorMessage

string

Error Message shown in Control Hub when status is set to disabled.

Response Properties

string

The Data Source Id.

schemaId

string

The schema id used for the data exchange.

url

string

The URL of the endpoint where Webex will send the data.

audience

string

The audience field in the JWT token. Usually, the DAPs app name.

subject

string

Rhe subject field in the JWT token. Usually, an indication of the app's function

nonce

string

Unique nonce used in the encryption of the JWT token.

tokenLifetimeMinutes

number

The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration

status

string

The status of the Data Source; active or disabled

errorMessage

string

Error Message shown in Control Hub when status is set to disabled.

Response Codes

The list below describes the common success and error responses you should expect from the API.

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

PUT

/v1/dataSources/

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

schemaId
string
The schema id used for the data exchange.
url
string
The URL of the endpoint where Webex will send the data.
audience
string
The audience field in the JWT token. Usually, the DAPs app name.
subject
string
The subject field in the JWT token. Usually, an indication of the app's function
nonce
string
Unique nonce used in the encryption of the JWT token.
tokenLifetimeMinutes
number
The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration. Must be equal or less to 1440.
status
string
The status of the Data Source; `active` or `disabled`.
errorMessage
string
Error Message shown in Control Hub when status is set to `disabled`.

https://webexapis.com/v1/dataSources/f29bb291-5db0-411b-834a-e64f8dee0658

{
  "schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
  "url": "https://www.byods.com/service1",
  "audience": "MedDocVirtualAgent",
  "subject": "callAudioData",
  "nonce": "jeieu38udue83u398",
  "tokenLifetimeMinutes": null,
  "status": "active",
  "errorMessage": "down for maintenance"
}

200 / OK

{
  "id": "f29bb291-5db0-411b-834a-e64f8dee0658",
  "schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
  "url": "https://www.byods.com/service1",
  "audience": "MedDocVirtualAgent",
  "subject": "callAudioData",
  "nonce": "jeieu38udue83u398",
  "tokenLifetimeMinutes": 60,
  "status": "active",
  "errorMessage": "down for maintenance"
}