API Methods - Node
The API methods that can be used with the RCNode to affect the node itself.
getNodeConnectUser
Connect user to the node. This reserves one of the remaining session slots for the current user (until /project/create, /project/open or /node/disonnectuser is used).
GET
/node/connectuser
Parameters
Header parameters
| Name | Description | Necessity |
| clientId* |
UUID (uuid)
Client identifier |
Required |
| appToken* |
String
Caller application identifier |
Required |
Responses
-
Status: 200 - OK
-
Status: 400 - Bad Request
Schema:
apiError {
code: integer
message: string
}
-
Status: 401 - Unauthorized
Schema:
apiError {
code: integer
message: string
}
Schema:
apiError {
code: integer
message: string
}
-
Status: 500 - Internal Server apiError
Schema:
apiError {
code: integer
message: string
}
getNodeConnection
Query RCNode connection information (available only on localhost). Returns RCNode connection information.
GET
/node/connection
Parameters
Header parameters
| Name | Description | Necessity |
| clientId* |
UUID (uuid)
Client identifier |
Required |
| appToken* |
String
Caller application identifier |
Required |
Responses
Schema:
RC Node Connection Information {
protocol: string
Connection protocol (http or https)
hostAddress: string
Local IPv4 address on which RCNode listens
port: string
Port on which RCNode listens
authToken: string
Token to authorize with RCNode
pairingPage: string
URL path to pairing page
landingPage: string
URL path to landing page
allAddresses: [string]
IPv4 addresses of all local network adapters
}
-
Status: 400 - Bad Request
Schema:
apiError {
code: integer
message: string
}
-
Status: 401 - Unauthorized
Schema:
apiError {
code: integer
message: string
}
Schema:
apiError {
code: integer
message: string
}
Schema:
apiError {
code: integer
message: string
}
-
Status: 500 - Internal Server apiError
Schema:
apiError {
code: integer
message: string
}
getNodeDisconnectUser
Disconnect user from the node. This removes the session slot reservaton allocated by /node/connectuser.
GET
/node/disconnectuser
Parameters
Header parameters
| Name | Description | Necessity |
| clientId* |
UUID (uuid)
Client identifier |
Required |
| appToken* |
String
Caller application identifier |
Required |
Responses
-
Status: 200 - OK
-
Status: 400 - Bad Request
Schema:
apiError {
code: integer
message: string
}
-
Status: 401 - Unauthorized
Schema:
apiError {
code: integer
message: string
}
Schema:
apiError {
code: integer
message: string
}
-
Status: 500 - Internal Server apiError
Schema:
apiError {
code: integer
message: string
}
getNodeProjects
List the RCNode projects. Return a list of locally stored projects.
GET
/node/projects
Parameters
Header parameters
| Name | Description | Necessity |
| clientId* |
UUID (uuid)
Client identifier |
Required |
| appToken* |
String
Caller application identifier |
Required |
Responses
Schema:
[
RC Project Information {
name: string
Project name
guid: string
Project guid
timeStamp: integer
Last access time stamp
}
]
-
Status: 400 - Bad Request
Schema:
apiError {
code: integer
message: string
}
-
Status: 401 - Unauthorized
Schema:
apiError {
code: integer
message: string
}
-
Status: 500 - Internal Server apiError
Schema:
apiError {
code: integer
message: string
}
getNodeStatus
Query and return the RCNode status.
GET
/node/status
Parameters
Header parameters
| Name | Description | Necessity |
| clientId* |
UUID (uuid)
Client identifier |
Required |
| appToken* |
String
Caller application identifier |
Required |
Responses
Schema:
RC Node Status {
status: string
RC Node status
apiVersion: string
API version string (with format 'major.minor'
activeSessions: integer
Currently active sessions
maxSessions: integer
Maximum concurrent sessions
sessionIds: [string]
Array of active session ids
}
-
Status: 400 - Bad Request
Schema:
apiError {
code: integer
message: string
}
-
Status: 401 - Unauthorized
Schema:
apiError {
code: integer
message: string
}
-
Status: 500 - Internal Server apiError
Schema:
apiError {
code: integer
message: string
}