The Service Order Open API provides a standardized mechanism for placing service orders.
This API is a ServiceNow implementation of the Open API Forum TMF641 Service Ordering Management API specification.
How to Enable- To Access it Order Management for Telecommunications (sn_ind_tmt_orm) plugin must be activated.
In UTAH version it supports GET,POST and PATCH operations.
Once Plugin is activated you can see this in Rest API explorer.
Sample JSON Payload For POST Call -
POST https://dev76115.service-now.com/api/sn_ind_tmt_orm/serviceorder
| { |
| "id": "2392d9da777301108e191e599a5a9919", |
| "ponr": "true", |
| "priority": 4, |
| "completionDate": "2024-11-12T06:19:17.000Z", |
| "expectedCompletionDate": "2020-06-26T13:07:40.000Z", |
| "orderDate": "2024-11-11T20:25:49.000Z", |
| "requestedCompletionDate": "2020-06-26T13:07:40.000Z", |
| "requestedStartDate": "2020-06-26T13:07:40.000Z", |
| "serviceOrderItem": [ |
| { |
| "id": "0", |
| "ponr": "true", |
| "action": "add", |
| "service": { |
| "@type": "Service", |
| "state": "", |
| "serviceType": "cfs", |
| "serviceCharacteristic": [ |
| { |
| "name": "CPE Type", |
| "valueType": "choice", |
| "value": "Physical", |
| "previousValue": "" |
| }, |
| { |
| "name": "Firewall Security", |
| "valueType": "choice", |
| "value": "Basic", |
| "previousValue": "" |
| }, |
| { |
| "name": "Firewall coverage", |
| "valueType": "choice", |
| "value": "Premium(Up to 50 sites)", |
| "previousValue": "" |
| }, |
| { |
| "name": "Administration Support", |
| "valueType": "choice", |
| "value": "Basic( Customer Managed)", |
| "previousValue": "" |
| } |
| ], |
| "serviceSpecification": { |
| "id": "f99546ff07266010a7955b7e0ad300a8", |
| "name": "Managed Firewall Service", |
| "version": "", |
| "internalVersion": "2", |
| "internalId": "f99546ff07266010a7955b7e0ad300a8", |
| "@type": "ServiceSpecificationRef" |
| } |
| }, |
| "state": "completed", |
| "version": "1", |
| "@type": "ServiceOrderItem" |
| } |
| ], |
| "relatedParty": [ |
| { |
| "id": "ffc68911c35420105252716b7d40dd55", |
| "name": "Funco Intl", |
| "@type": "RelatedParty", |
| "@referredType": "Customer" |
| }, |
| { |
| "id": "eaf68911c35420105252716b7d40ddde", |
| "name": "Sally Thomas", |
| "@type": "RelatedParty", |
| "@referredType": "CustomerContact" |
| } |
| ], |
| "state": "completed", |
| "version": "1", |
| "@type": "ServiceOrder" |
| } |
Service Order Is Created , Check for Response
Actual Order
We will approve the Order and then Send a PATCH for Service Order Update.
JSON Payload is Updated for PATCH Simulation in JSON editor.
Patch Order URL
PATCH https://dev76115.service-now.com/api/sn_ind_tmt_orm/serviceorder/{id}
We will use the Sys_ID field in PATCH in rest api explorer.
Patch Json Payload.
{
"id": "df483ea32fa22110d6d4debcf699b62a",
"ponr": "true",
"priority": 4,
"completionDate": "2024-11-12T06:19:17.000Z",
"expectedCompletionDate": "2020-06-26T13:07:40.000Z",
"orderDate": "2024-11-11T20:25:49.000Z",
"requestedCompletionDate": "2020-06-26T13:07:40.000Z",
"requestedStartDate": "2020-06-26T13:07:40.000Z",
"serviceOrderItem": [
{
"id": "0",
"ponr": "true",
"action": "add",
"service": {
"@type": "Service",
"state": "",
"serviceType": "cfs",
"serviceCharacteristic": [
{
"name": "CPE Type",
"valueType": "choice",
"value": "Virtual",
"previousValue": "Physical"
},
{
"name": "Firewall Security",
"valueType": "choice",
"value": "Basic",
"previousValue": ""
},
{
"name": "Firewall coverage",
"valueType": "choice",
"value": "Premium(Up to 50 sites)",
"previousValue": ""
},
{
"name": "Administration Support",
"valueType": "choice",
"value": "Basic( Customer Managed)",
"previousValue": ""
}
],
"serviceSpecification": {
"id": "f99546ff07266010a7955b7e0ad300a8",
"name": "Managed Firewall Service",
"version": "",
"internalVersion": "2",
"internalId": "f99546ff07266010a7955b7e0ad300a8",
"@type": "ServiceSpecificationRef"
}
},
"state": "new",
"version": "1",
"@type": "ServiceOrderItem"
}
],
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"state": "new",
"version": "1",
"@type": "ServiceOrder",
"orderCurrency": "USD"
}
=================
Patch operations response
This is how Service Order Looks Like . It Again went for Approval , Version is changed to 2.
Value of Characteristics CPE Type is updated now .
Now It can reapproved for fulfillment.
Hope This helps.
Regards
RP
