2-4 Agent operations
Retrieve a list of agents
This API retrieves a list of agents.
https://api.svfcloud.com/v1/agents
GET
application/json
Query parameter
Query parameter
Value
Required
Description
name
Agent name
Specify the name of the agent whose information is to be retrieved.
Request header
Header field
Value
Description
Authorization
Bearer {your access token}
Specify the access token retrieved via authentication.
Response
Code | Description |
|---|---|
HTTP/1.1 200 OK | Indicates that the process was executed successfully. |
HTTP/1.1 401 Unauthorized | Occurs if the authentication information is invalid. |
HTTP/1.1 429 Too many Requests | Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header. |
[
{
"id":"8f885615-72dd-4166-af30-310585f1de45",
"segment":"",
"name": "Tokyo Sales Office",
"platform":"OS X",
"ipAddress":"10.XX.XX.XX",
"maxSize":0,
"lastModified":"2015-12-11T11:34:30.000Z",
"search":{
"interval":5,
"local":true,
"broadcast":false,
"addresses":
[
]
},
"printers":[
{
"id":"41137e28-6e69-4e82-9279-1221d594353",
"key":"32C44176298E06C83D541F142E383A96A8734861",
"stateUpdated":"2015-10-01T09:12:32.000Z",
"name":"10.XX.XX.XX",
"manufacturer":"Unknown",
"reachable":false,
"description":"10.XX.XX.XX",
"pdlList":[
"PDF",
"POSTSCRIPT"
],
"segment":"",
"state":0,
"localPrinter":{
"name":"10.XX.XX.XX","platform":"OS X","paused":false}
}
]
},
{
"id":"c8ddaafd-d563-4841-9908-13042d5afe53",
"segment":"",
"name": "Osaka Sales Office",
"platform":"Windows",
"ipAddress":"10.XX.XX.XX",
"maxSize":0,
"lastModified":"2015-12-11T11:34:30.000Z",
"search":{
"interval":5,
"local":true,
"broadcast":false,
"addresses":[
]
},
"printers":[
{
"id":"c8ddaafd-d563-4841-9908-13042d5afe53",
"key":"ED7054AB697F38EE330C9AE5F613DAD6AD1ED5A3",
"stateUpdated":"2015-10-02T08:34:02.000Z",
"name":"DocuCentre-IV C2270",
"manufacturer":"FUJI XEROX",
"reachable":true,
"ipAddress":"10.XX.XX.XX",
"description":"FUJI XEROX DocuCentre-IV C2270;ESS1.0.42,IOT 41.3.0,IIT 2.21.1,ADF 7.9.0,FAX 1.1.14,SJFI3.0.13,SSMI1.12.3",
"pdlList":[
"ART4",
"EMF",
"ESCP",
"PDF"
],
"segment":"",
"state":12,
"localPrinter":{
"name":"FX DocuCentre-IV C2270",
"platform":"Windows",
"manufacturer":"Fuji Xerox",
"driverName":"FX DocuCentre-IV C2270",
"paused":false
}
}
]
}
]Key | Content | Description |
|---|---|---|
id | Agent ID | The ID that identifies the agent. |
name | Agent name | The agent name specified on the SVF Cloud Agent Settings screen. |
platform | Platform | Information about the platform that the agent is running on. |
ipAddress | IP address | The IP address for the agent. |
lastModified | Last update time | The date and time of last update. This is updated every time the agent reports the status. |
search | Printer search information | The definition information to be used by the agent when searching for printers. |
printers | Printer information | The list of printers that the agent holds. |
Any key items that are not included in the list are not currently used. They have been defined for future use.
Retrieve agent information
This API retrieves information about the specified agent.
https://api.svfcloud.com/v1/agents/{agentId}GET
application/json
Path parameter
Path parameter
Value
Required
Description
agentId
Agent ID
Specify the ID of the agent whose information is to be retrieved.
Request header
Header field
Value
Description
Authorization
Bearer {your access token}
Specify the access token retrieved via authentication.
Response
Code | Description |
|---|---|
HTTP/1.1 200 OK | Indicates that the process was executed successfully. |
HTTP/1.1 401 Unauthorized | Occurs if the authentication information is invalid. |
HTTP/1.1 404 Not Found | Occurs if the agent with the specified ID does not exist. |
HTTP/1.1 429 Too many Requests | Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header. |
{
"id":"8f885615-72dd-4166-af30-310585f1de45",
"segment":"",
"name": "Tokyo Sales Office",
"platform":"OS X",
"ipAddress":"10.XX.XX.XX",
"maxSize":0,
"lastModified":"2015-12-11T11:34:30.000Z",
"search":{
"interval":5,
"local":true,
"broadcast":false,
"addresses":[
]
},
"printers":[
{
"id":"41137e28-6e69-4e82-9279-1221d594353",
"key":"32C44176298E06C83D541F142E383A96A8734861",
"stateUpdated":"2015-10-01T09:12:32.000Z",
"name":"10.XX.XX.XX",
"manufacturer":"Unknown",
"reachable":false,
"description":"10.XX.XX.XX",
"pdlList":[
"PDF",
"POSTSCRIPT"
],
"segment":"",
"state":0,
"localPrinter":{
"name":"10.XX.XX.XX",
"platform":"OS X",
"paused":false
}
}
]
}Key | Content | Description |
|---|---|---|
id | Agent ID | The ID that identifies the agent. |
name | Agent name | The agent name specified on the SVF Cloud Agent Settings screen. |
platform | Platform | Information about the platform that the agent is running on. |
ipAddress | IP address | The IP address for the agent. |
lastModified | Last update time | The date and time of last update. This is updated every time the agent reports the status. |
search | Printer search information | The definition information to be used by the agent when searching for printers. |
printers | Printer information | The list of printers that the agent holds. |
Any key items that are not included in the list are not currently used. They have been defined for future use.
Delete agents
This API deletes the specified agent.
https://api.svfcloud.com/v1/agents/{agentId}DELETE
Path parameter
Path parameter
Value
Required
Description
agentId
Agent ID
Specify the ID of the agent to delete.
Request header
Header field
Value
Description
Authorization
Bearer {your access token}
Specify the access token retrieved via authentication.
Response
Code | Description |
|---|---|
HTTP/1.1 204 No Content | Indicates that the process was executed successfully. |
HTTP/1.1 401 Unauthorized | Occurs if the authentication information is invalid. |
HTTP/1.1 429 Too many Requests | Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header. |