NodeResource

NodeResource REST endpoint to access and manipulate specific Node data. Copyright 2013 WANdisco.

The following resources are part of this group:

• /node/{nodeIdentity}
• /node/{nodeIdentity}/attributes
• /node/{nodeIdentity}/membershipfris
• /node/{nodeIdentity}/statemachines
• /node/{nodeIdentity}/ecosystem/removenodes
• /node/{nodeIdentity}/statemachine/{dsmId}
• /node/{nodeIdentity}/statemachine/{dsmId}/coordinatestopoutput
• /node/{nodeIdentity}/statemachine/{dsmId}/lastdelivered
• /node/{nodeIdentity}/statemachine/{dsmId}/lastoutput
• /node/{nodeIdentity}/statemachine/{dsmId}/membership
• /node/{nodeIdentity}/statemachine/{dsmId}/startoutput
• /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestartoutput
• /node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestopoutput
• /node/{nodeIdentity}/statemachine/{dsmId}/unsideline
• /node/{nodeIdentity}/statemachine/{dsmId}/membership/{membershipIdentity}
• /node/{nodeIdentity}/statemachine/{dsmId}/node/{nodeId}
• /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/remove
• /node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/set

/node/{nodeIdentity}

Mount Point: /api/node/{nodeIdentity}

GET

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml application/json

a node with a given identity.

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path

Request Body

element:	inductionTicket
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/attributes

Mount Point: /api/node/{nodeIdentity}/attributes

GET

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml application/json

the attributes for the node with the given identity.

PUT

Update the attributes of a Node

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path

Request Body

element:	attributes
media types:	*/* application/xml

(no documentation provided)

Response Body

element:	(custom)
media types:	application/xml application/json

a node with a given identity

/node/{nodeIdentity}/membershipfris

Mount Point: /api/node/{nodeIdentity}/membershipfris

GET

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml

a list of membership-family representative identities for the node.

/node/{nodeIdentity}/statemachines

Mount Point: /api/node/{nodeIdentity}/statemachines

GET

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
history	(no documentation provided)	query	false

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/node/{nodeIdentity}/ecosystem/removenodes

Mount Point: /api/node/{nodeIdentity}/ecosystem/removenodes

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path

Request Body

element:	nodes
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}

GET

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path
history	(no documentation provided)	query	false

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/coordinatestopoutput

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/coordinatestopoutput

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Request Body

element:	nodes
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/lastdelivered

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/lastdelivered

GET

Note different outputs: plain text or xml/json if there's an exception.

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml text/plain application/json

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/lastoutput

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/lastoutput

GET

Note different outputs: plain text or xml/json if there's an exception.

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml text/plain application/json

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/membership

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/membership

GET

Find the membership associated with the given dsm.

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/startoutput

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/startoutput

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Request Body

element:	nodes
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestartoutput

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestartoutput

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestopoutput

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/uncoordinatestopoutput

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/unsideline

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/unsideline

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path
membershipIdentity	(no documentation provided)	query
resumeFrom	(no documentation provided)	query

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/membership/{membershipIdentity}

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/membership/{membershipIdentity}

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path
membershipIdentity	(no documentation provided)	path

Response Body

element:	(custom)
media types:	application/xml application/json

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/node/{nodeId}

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/node/{nodeId}

DELETE

Remove nodes from the specified DSM.

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path
nodeIdToRemove	(no documentation provided)	path

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/remove

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/remove

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Request Body

element:	nodes
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)

/node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/set

Mount Point: /api/node/{nodeIdentity}/statemachine/{dsmId}/skipthreshold/set

PUT

Parameters

name	description	type	default
nodeIdentity	(no documentation provided)	path
dsmId	(no documentation provided)	path

Request Body

element:	skipthreshold
media types:	application/xml application/json

(no documentation provided)

Response Body

element:	(custom)
media types:	*/* application/xml

(no documentation provided)