NodeResource
Platform translation API for Node operations
The following resources are part of this group:
- /node/{nodeIdentity}
- /node/{nodeIdentity}/get-node-ecosystem-dsm
- /node/{nodeIdentity}/start-node-ecosystem-output
- /node/{nodeIdentity}/stop-node-ecosystem-output
/node/{nodeIdentity}
Mount Point: /api/node/{nodeIdentity}
PUT
Process the specified induction ticket
Parameters
| name | description | type | default |
|---|---|---|---|
| nodeIdentity | (no documentation provided) | path |
Request Body
| element: | inductionTicket |
| media types: | application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 202 | Accepted |
| 400 | Bad Request - see Exception |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
GET
Returns the specified node
Parameters
| name | description | type | default |
|---|---|---|---|
| nodeIdentity | (no documentation provided) | path |
Response Body
| element: | node |
| media types: | application/xml |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 200 | Ok |
| 404 | Not Found- see Exception |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/node/{nodeIdentity}/get-node-ecosystem-dsm
Mount Point: /api/node/{nodeIdentity}/get-node-ecosystem-dsm
GET
Advanced use only. See User Manual for usage.
Parameters
| name | description | type | default |
|---|---|---|---|
| nodeIdentity | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 200 | Ok |
| 404 | Not Found- see Exception |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/node/{nodeIdentity}/start-node-ecosystem-output
Mount Point: /api/node/{nodeIdentity}/start-node-ecosystem-output
PUT
Advanced use only. See User Manual for usage.
Parameters
| name | description | type | default |
|---|---|---|---|
| nodeIdentity | (no documentation provided) | path |
Request Body
| element: | nodes |
| media types: | application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 202 | Accepted |
| 400 | Bad Request - see Exception |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |
/node/{nodeIdentity}/stop-node-ecosystem-output
Mount Point: /api/node/{nodeIdentity}/stop-node-ecosystem-output
PUT
Advanced use only. See User Manual for usage.
Parameters
| name | description | type | default |
|---|---|---|---|
| nodeIdentity | (no documentation provided) | path |
Request Body
| element: | nodes |
| media types: | application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 202 | Accepted |
| 400 | Bad Request - see Exception |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |