[Index]
Model ref.: relation/GS_DeviceOOS_REL
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"deviceName": {
"type": "string",
"title": "Device Name"
},
"description": {
"type": "string",
"title": "Description"
},
"ownerId": {
"type": "string",
"title": "Associated User"
},
"associatedLine": {
"type": "string",
"title": "First Line on Device"
},
"oosDate": {
"type": "string",
"title": "Out of Service Date"
},
"oosIndex": {
"type": "string",
"title": "Out of Service Index"
},
"SearchType": {
"choices": [
{
"value": "Phone",
"title": "Phone"
},
{
"value": "Device Profile",
"title": "Device Profile"
},
{
"value": "All Devices For User",
"title": "All Devices For User"
},
{
"value": "All Devices With Line",
"title": "All Devices With Line"
}
],
"required": false,
"type": "string",
"title": "Find Device By"
},
"labels": {
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"title": "Line Index"
},
"label": {
"type": "string",
"title": "Line Label"
}
}
},
"type": "array",
"title": "Labels"
},
"additionalAttributes": {
"title": "Additional Attributes",
"type": "object",
"properties": {
"deviceName": {
"type": "string",
"title": "Device Name"
},
"restoreService": {
"type": "boolean",
"title": "Restore Service"
},
"deleteDevice": {
"type": "boolean",
"title": "Delete Device"
},
"setOos": {
"type": "boolean",
"title": "Set Device OOS"
}
}
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/GS_DeviceOOS_REL/add/ |
|
The GUI Add form of relation/GS_DeviceOOS_REL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/GS_DeviceOOS_REL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/GS_DeviceOOS_REL | POST | /api/relation/GS_DeviceOOS_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/GS_DeviceOOS_REL/ |
|
The relation/GS_DeviceOOS_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/GS_DeviceOOS_REL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "oosIndex",
"direction": "asc",
"current": "/api/relation/GS_DeviceOOS_REL/?skip=0&limit=3&order_by=oosIndex&direction=asc&traversal=down"
},
"operations": [
"list",
"get",
"update",
"help",
"export_bulkload_template",
"field_display_policy",
"configuration_template",
"add",
"export",
"bulk_update",
"remove"
],
"meta": {
"model_type": "relation/GS_DeviceOOS_REL",
"summary_attrs": [
{
"name": "oosIndex",
"title": "Out of Service Index"
},
{
"name": "oosDate",
"title": "Out of Service Date"
},
{
"name": "deviceName",
"title": "Device Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "ownerId",
"title": "Associated User"
},
{
"name": "associatedLine",
"title": "First Line on Device"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/GS_DeviceOOS_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"get",
"export",
"update",
"export_bulkload_template",
"add",
"remove"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/GS_DeviceOOS_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/GS_DeviceOOS_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/GS_DeviceOOS_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/GS_DeviceOOS_REL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/GS_DeviceOOS_REL/[pkid] | hierarchy=[hierarchy] | The relation/GS_DeviceOOS_REL instance with [pkid]. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Delete Device | POST | /api/relation/GS_DeviceOOS_REL/[pkid]/+DeleteDevice | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Restore Service | POST | /api/relation/GS_DeviceOOS_REL/[pkid]/+RestoreService | hierarchy=[hierarchy] | If payload required: |