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}/pendingTransactions
- /node/{nodeIdentity}/removenodes
- /node/{nodeIdentity}/start-node-ecosystem-output
- /node/{nodeIdentity}/stop-node-ecosystem-output
- /node/{nodeIdentity}/setNodeName/{nodeName}
/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}/pendingTransactions
Mount Point: /api/node/{nodeIdentity}/pendingTransactions
GET
Returns the number of pending transactions for the specified node
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}/removenodes
Mount Point: /api/node/{nodeIdentity}/removenodes
PUT
Advanced use only. See User Manual for usage.
Remove the specified nodes from the system. Note that node(s) to be removed must NOT be part of an active replication group.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 |
| 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 |
/node/{nodeIdentity}/setNodeName/{nodeName}
Mount Point: /api/node/{nodeIdentity}/setNodeName/{nodeName}
PUT
Advanced use only. See User Manual for usage.
Set the specified nodes name.Parameters
| name | description | type | default |
|---|---|---|---|
| nodeIdentity | (no documentation provided) | path | |
| nodeName | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
Status Codes
| code | description |
|---|---|
| 202 | Accepted |
| 400 | Bad Request - see Exception |
| 404 | Not Found- see Exception |
| 401 | Authentication required. |
| 403 | Authorization required - access forbidden |