UpdateNetworkAttributes RESTified API
- Jason Andrew
- Mickey Bushman
Resource URL Summary
Pass Through Call to Dispatch's "Update Network Attributes" API
PUT /up/v5/job/${WorkItemId}/networkAttributes
API Specific Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
|
| Yes | The unique string ID value for the Work Item. |
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specifics
Pass Through Call to Dispatch's "Update Network Attributes" API
This RESTified API will perform a pass-through call to the Dispatch sub-system's "Update Network Attributes" API (when configured).
URL
PUT /up/v5/job/${WorkItemId}/networkAttributes
HTTP Request Body
This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Dispatch "Update Network Attributes" API.
UpdateNetworkAttributes Object Format
[
{
"attributeLabel": "Attribute Label Example #1",
"attributeValue": "Attribute Label Value #1"
},
{
"attributeLabel": "Attribute Label Example #2",
"attributeValue": "Attribute Label Value #2"
},
// ...
]
UpdateNetworkAttributes Object Properties
| Property | Type | Required? | Description | Dispatch Field Mapping | |
|---|---|---|---|---|---|
array | Yes | Pass through parameter to the Dispatch "Update Network Attributes" API. | - | ||
attributeLabel | string | Yes | Pass through parameter to the Dispatch "Update Network Attributes" API. | attributeLabel | |
attributeValue | string | Yes | Pass through parameter to the Dispatch "Update Network Attributes" API. | attributeValue | |
HTTP Response
Success
On success, a JSON-formatted version of the Dispatch "Update Network Attributes" API response will be returned.
{
"Success": true,
"Code": 0,
"Message": "OK"
}
Error
On error, a JSON-formatted version of the Dispatch "Update Network Attributes" API response will be returned.
{
"Success": false,
"Code": 9,
"Message": "Unable to updated the Network Attributes : ${WorkItemId}"
}
Return Codes
In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.
Resource URL Summary
Pass Through Call to Dispatch's "Update Network Attributes" API
PUT /up/v5/job/${WorkItemId}/networkAttributes
API Specific Parameters
| Parameter | Type | Required? | Description |
|---|---|---|---|
|
| Yes | The unique string ID value for the Work Item. |
HTTP Headers
This API uses the standard ServiceBroker HTTP Headers.
API Specifics
Pass Through Call to Dispatch's "Update Network Attributes" API
This RESTified API will perform a pass-through call to the Dispatch sub-system's "Update Network Attributes" API (when configured).
URL
PUT /up/v5/job/${WorkItemId}/networkAttributes
HTTP Request Body
This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the Dispatch "Update Network Attributes" API.
UpdateNetworkAttributes Object Format
[
{
"attributeLabel": "Attribute Label Example #1",
"attributeValue": "Attribute Label Value #1"
},
{
"attributeLabel": "Attribute Label Example #2",
"attributeValue": "Attribute Label Value #2"
},
// ...
]
UpdateNetworkAttributes Object Properties
| Property | Type | Required? | Description | Dispatch Field Mapping | |
|---|---|---|---|---|---|
array | Yes | Pass through parameter to the Dispatch "Update Network Attributes" API. | - | ||
attributeLabel | string | Yes | Pass through parameter to the Dispatch "Update Network Attributes" API. | attributeLabel | |
attributeValue | string | Yes | Pass through parameter to the Dispatch "Update Network Attributes" API. | attributeValue | |
HTTP Response
Success
On success, a JSON-formatted version of the Dispatch "Update Network Attributes" API response will be returned.
{
"Success": true,
"Code": 0,
"Message": "OK"
}
Error
On error, a JSON-formatted version of the Dispatch "Update Network Attributes" API response will be returned.
{
"Success": false,
"Code": 9,
"Message": "Unable to updated the Network Attributes : ${WorkItemId}"
}
Return Codes
In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.