Service Order

Developer Portal

Change

Resource Inventory

Service Order

Trouble Ticket

Back

Service Order

Released on Mar-23-2020

TMF version: TMF641 v4.6

Protocols: REST

Bell version: v1.4

Last updated: Jun-03-2023

Swagger

Specification file

Overview
GET /serviceOrder
POST /serviceOrder
GET /serviceOrder/{id}
PATCH /serviceOrder/{id}
POST /hub
GET /monitor/{monitorId}

Business overview

The following document is the specification of the REST API for Service Order Management (TMF-641). This API will enable partners to establish a B2B with Bell Canada to manage service requests. It includes the model definition as well as all available operations. Possible actions are creating, updating and retrieving Service Orders (including filtering).

The following assumptions were considered in the development of this document:

The Partner has access to a catalog system
A service order will describe a list of service order items.
A service order item references an action on an existing service or service to be added.

The Service Order API supports the following functions:

Sr No.	Operation	Flow	Origin	Description
1	CreateServiceOrder	Partner To Bell	Customer Initiated	Partner initiates a creation of Service Request. The API offer guaranteed message delivery.
2	PatchServiceOrder	Partner To Bell	Customer Initiated	Partner can send an Update request for an existing Service Request into Bell (by Bell SR ID). The API offers guaranteed message delivery. This API is used to update allowable SR details such as worklog.
3	GetServiceOrder	Partner To Bell	Customer Initiated	Get Service Request details for the given Bell SR ID. Note: Currently not available; will be implemented in the near future.
4	GetServiceOrderList	Partner To Bell	Customer Initiated	Get list of Service Requests. All the SRs created internal by Bell or Externally by Partners can be retrieved for the given customer. Note: Currently not available; will be implemented in the near future.
5	CreateHub	Utility	Customer Initiated	Create Hub to register a listener for all incoming communications/notifications from Bell to Customer. Hub enables publish and subscribe pattern for the create and update notifications.
6	GetHub	Utility	Customer Initiated	Retrieve Hub already created on Bell. Customer can retrieve all the listeners registered on hub for a specific Hub ID.
7	DeleteHub	Utility	Customer Initiated	Delete a Hub resource on Bell. Customer can delete registered Hub by Hub ID
8	GetMonitor	Utility	Customer Initiated	Retrieve service order status at any given point in time. This is mainly used when the operation is asynchronous. This function is optional; The client may chose to integrate it or not.
9	Publish Notification	Bell To Partner	Bell Initiated	Bell sends update notifications, status change notifications, outbound communications or BELL initiated service order notification via registered listener on Hub.

GET /serviceOrder

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
    'SECURITY_CREDENTIALS',
    'accept': "application/json;charset=utf-8"
     'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
     'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader( 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Path

GET /serviceOrder

Parameters

fields		Comma separated properties to display in response
Optional In Query
string

offset		Requested index for start of resources to be provided in response
Optional In Query
Integer

limit		Requested number of resources to be provided in response
Optional In Query
Integer

filters		Comma-separated properties used to filter the service order list
Optional In Query
string

Accept		application/json
Optional in header		application/json;charset=utf-8
string

Response

200

Success

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

POST /serviceOrder

Curl
Python
PHP
Java

Example Request

 curl --request POST \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'content-type: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' \
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  --data '{ "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.", "externalId": "715705529925632", "priority": "cebude", "requestedStartDate": "2020-04-08T03:54:33.115Z", "note": [ { "text": "worklog", "noteType": "worklog", "summary": "test", "logtype": "ClientNote" } ], "orderItem": [ { "id": "5134504144404480", "action": "add", "orderItemRelationship": [ { "id": "3222146583101440", "relationshipType": "PrimaryCi", "@baseType": "fogofa", "@schemaLocation": "bobuvu", "@type": "parujo" } ] } ], "orderRelationship": [ { "id": "5285490846597120", "href": "wabw", "relationshipType": "37.45.132.30", "@baseType": "zorura", "@schemaLocation": "walat", "@type": "silojnuh", "@referredType": "pujnowjo" } ], "relatedParty": [ { "name": "Ethan Hunt", "role": "onbehalfof" }, { "name": "Ethan Hunt", "role": "originator" }, { "name": "RTJK", "role": "affectedcustomer" }, { "role": "sitecontact1", "party": { "givenName": "Ethan", "familyName": "Hunt", "contactMedium": [ { "type": "telephone", "medium": { "number": "6474642347432Ext893364" } }, { "type": "mobile", "medium": { "number": "1234789" } }, { "type": "emailAddress", "medium": { "emailAddress": "ethan@gmail.com" } } ] } }, { "role": "sitecontact2", "party": { "givenName": "Jeff", "familyName": "Jones", "contactMedium": [ { "type": "telephone", "medium": { "number": "514516799145145Ext123234" } }, { "type": "mobile", "medium": { "number": "65678346075890" } } ] } } ], "attachment": [ { "name": "Attachment1", "mimeType": "text", "data": "PD94bWwgdmVyc2lvbj0i=" } ], "state": "NEW", "sourceSystemId": "A478", "@baseType": "fogew", "@schemaLocation": "suce", "@type": "kipeve" }'

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

payload = "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}"

headers = {
   'SECURITY_CREDENTIALS',
    'content-type': "application/json;charset=utf-8",
    'accept': "application/json;charset=utf-8",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("POST", "", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    "content-type: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}");
Request request = new Request.Builder()
  .url("")
  .post(body)
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Path

Post /serviceOrder

Parameters

serviceOrder		The ServiceOrder to be created
Required in body		BellServiceOrder_Create
object

Content-Type		application/json
Optional in header		application/json;charset=utf-8
string

Accept		application/json
Optional in header		application/json;charset=utf-8
Integer

Response

200

Success

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

GET /serviceOrder/{id}

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
   'SECURITY_CREDENTIALS',
    'accept': "application/json;charset=utf-8",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Path

GET /serviceOrder/{id}

Parameters

id		Identifier of the ServiceOrder
Required in path
string

fields		Comma separated properties to display in response

Accept		application/json
Optional in header		application/json;charset=utf-8
string

Response

200

Success

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

PATCH /serviceOrder/{id}

Curl
Python
PHP
Java

Example Request

curl --request PATCH \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'content-type: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' \
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  --data '{ "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.", "externalId": "715705529925632", "priority": "cebude", "requestedStartDate": "2020-04-08T03:54:33.115Z", "note": [ { "text": "worklog", "noteType": "worklog", "summary": "test", "logtype": "ClientNote" } ], "orderItem": [ { "id": "5134504144404480", "action": "add", "orderItemRelationship": [ { "id": "3222146583101440", "relationshipType": "PrimaryCi", "@baseType": "fogofa", "@schemaLocation": "bobuvu", "@type": "parujo" } ] } ], "orderRelationship": [ { "id": "5285490846597120", "href": "wabw", "relationshipType": "37.45.132.30", "@baseType": "zorura", "@schemaLocation": "walat", "@type": "silojnuh", "@referredType": "pujnowjo" } ], "relatedParty": [ { "name": "Ethan Hunt", "role": "onbehalfof" }, { "name": "Ethan Hunt", "role": "originator" }, { "name": "RTJK", "role": "affectedcustomer" }, { "role": "sitecontact1", "party": { "givenName": "Ethan", "familyName": "Hunt", "contactMedium": [ { "type": "telephone", "medium": { "number": "6474642347432Ext893364" } }, { "type": "mobile", "medium": { "number": "1234789" } }, { "type": "emailAddress", "medium": { "emailAddress": "ethan@gmail.com" } } ] } }, { "role": "sitecontact2", "party": { "givenName": "Jeff", "familyName": "Jones", "contactMedium": [ { "type": "telephone", "medium": { "number": "514516799145145Ext123234" } }, { "type": "mobile", "medium": { "number": "65678346075890" } } ] } } ], "attachment": [ { "name": "Attachment1", "mimeType": "text", "data": "PD94bWwgdmVyc2lvbj0i=" } ], "state": "NEW", "sourceSystemId": "A478", "@baseType": "fogew", "@schemaLocation": "suce", "@type": "kipeve" }'

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

payload = "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}"

headers = {
    'SECURITY_CREDENTIALS',
    'content-type': "application/json;charset=utf-8",
    'accept': "application/json;charset=utf-8",
    --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("PATCH", "", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    "content-type: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}");
Request request = new Request.Builder()
  .url("")
  .patch(body)
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Path

PATCH/serviceOrder/{id}

Parameters

id		Identifier of the ServiceOrder
Required in path
string

serviceOrder		The ServiceOrder to be updated
Required in body		ServiceOrder_Update
object

Content-Type		application/json
Optional in header		application/json;charset=utf-8
string

Accept		application/json
Optional in header		application/json;charset=utf-8
string

Response

202

Accepted

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

POST /hub

Curl
Python
PHP
Java

Example Request

curl --request POST \
  --url \
  --header 'accept: application/json;charset=utf-8' \
  --header 'content-type: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS'\
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  --data '{"callback":"ukoecole","query":"tamseep"}'

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

payload = "{\"callback\":\"ukoecole\",\"query\":\"tamseep\"}"

headers = {
    'SECURITY_CREDENTIALS',
    'content-type': "application/json;charset=utf-8",
    'accept': "application/json;charset=utf-8",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("POST", "", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"callback\":\"ukoecole\",\"query\":\"tamseep\"}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    "content-type: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{\"callback\":\"ukoecole\",\"query\":\"tamseep\"}");
Request request = new Request.Builder()
  .url("")
  .post(body)
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Path

POST/hub

Parameters

data		Data containing the callback endpoint to deliver the information
Required in body		EventSubscriptionInput
object

Content-Type		application/json
Optional in header		application/json; charset=utf-8
string

Accept		application/json
Optional in header		application/json; charset=utf-8
string

Response

201

Subscribed

EventSubscription

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

GET /monitor/{monitorId}

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url \
  --header 'accept: application/json' \
  --header 'SECURITY_CREDENTIALS' \
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

 {
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
    'SECURITY_CREDENTIALS',
    'accept': "application/json",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

 {
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

 {
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"
}

Path

GET/monitor/{monitorId}

Parameters

monitorId
Required in body
object

Accept		application/json
Optional in header
string

Response

200

The operation was successfull.

Monitor

Business overview

The following assumptions were considered in the development of this document:

The Partner has access to a catalog system
A service order will describe a list of service order items.
A service order item references an action on an existing service or service to be added.

The Service Order API supports the following functions:

Sr No.	Operation	Flow	Origin	Description
1	CreateServiceOrder	Partner To Bell	Customer Initiated	Partner initiates a creation of Service Request. The API offer guaranteed message delivery.
2	PatchServiceOrder	Partner To Bell	Customer Initiated	Partner can send an Update request for an existing Service Request into Bell (by Bell SR ID). The API offers guaranteed message delivery. This API is used to update allowable SR details such as worklog.
3	GetServiceOrder	Partner To Bell	Customer Initiated	Get Service Request details for the given Bell SR ID. Note: Currently not available; will be implemented in the near future.
4	GetServiceOrderList	Partner To Bell	Customer Initiated	Get list of Service Requests. All the SRs created internal by Bell or Externally by Partners can be retrieved for the given customer. Note: Currently not available; will be implemented in the near future.
5	CreateHub	Utility	Customer Initiated	Create Hub to register a listener for all incoming communications/notifications from Bell to Customer. Hub enables publish and subscribe pattern for the create and update notifications.
6	GetHub	Utility	Customer Initiated	Retrieve Hub already created on Bell. Customer can retrieve all the listeners registered on hub for a specific Hub ID.
7	DeleteHub	Utility	Customer Initiated	Delete a Hub resource on Bell. Customer can delete registered Hub by Hub ID
8	GetMonitor	Utility	Customer Initiated	Retrieve service order status at any given point in time. This is mainly used when the operation is asynchronous. This function is optional; The client may chose to integrate it or not.
9	Publish Notification	Bell To Partner	Bell Initiated	Bell sends update notifications, status change notifications, outbound communications or BELL initiated service order notification via registered listener on Hub.

GET /serviceOrder

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
    'SECURITY_CREDENTIALS',
    'accept': "application/json;charset=utf-8"
     'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
     'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader( 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

[
  {
    "id": "1140779233837056",
    "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
    "externalId": "715705529925632",
    "priority": "cebude",
    "requestedStartDate": "2020-04-08T03:54:33.115Z",
    "note": [
      {
        "text": "worklog",
        "noteType": "worklog",
        "summary": "test",
        "logtype": "ClientNote"
      }
    ],
    "orderItem": [
      {
        "id": "5134504144404480",
        "action": "add",
        "orderItemRelationship": [
          {
            "id": "3222146583101440",
            "relationshipType": "PrimaryCi",
            "@baseType": "fogofa",
            "@schemaLocation": "bobuvu",
            "@type": "parujo"
          }
        ]
      }
    ],
    "orderRelationship": [
      {
        "id": "5285490846597120",
        "href": "wabw",
        "relationshipType": "37.45.132.30",
        "@baseType": "zorura",
        "@schemaLocation": "walat",
        "@type": "silojnuh",
        "@referredType": "pujnowjo"
      }
    ],
    "relatedParty": [
      {
        "name": "Ethan Hunt",
        "role": "onbehalfof"
      },
      {
        "name": "Ethan Hunt",
        "role": "originator"
      },
      {
        "name": "RTJK",
        "role": "affectedcustomer"
      },
      {
        "role": "sitecontact1",
        "party": {
          "givenName": "Ethan",
          "familyName": "Hunt",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "6474642347432Ext893364"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "1234789"
              }
            },
            {
              "type": "emailAddress",
              "medium": {
                "emailAddress": "ethan@gmail.com"
              }
            }
          ]
        }
      },
      {
        "role": "sitecontact2",
        "party": {
          "givenName": "Jeff",
          "familyName": "Jones",
          "contactMedium": [
            {
              "type": "telephone",
              "medium": {
                "number": "514516799145145Ext123234"
              }
            },
            {
              "type": "mobile",
              "medium": {
                "number": "65678346075890"
              }
            }
          ]
        }
      }
    ],
    "attachment": [
      {
        "name": "Attachment1",
        "mimeType": "text",
        "data": "PD94bWwgdmVyc2lvbj0i="
      }
    ],
    "state": "NEW",
    "sourceSystemId": "A478",
    "@baseType": "fogew",
    "@schemaLocation": "suce",
    "@type": "kipeve"
  }
]

Path

GET /serviceOrder

Parameters

fields		Comma separated properties to display in response
Optional In Query
string

offset		Requested index for start of resources to be provided in response
Optional In Query
Integer

limit		Requested number of resources to be provided in response
Optional In Query
Integer

filters		Comma-separated properties used to filter the service order list
Optional In Query
string

Accept		application/json
Optional in header		application/json;charset=utf-8
string

Response

200

Success

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

POST /serviceOrder

Curl
Python
PHP
Java

Example Request

 curl --request POST \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'content-type: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' \
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  --data '{ "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.", "externalId": "715705529925632", "priority": "cebude", "requestedStartDate": "2020-04-08T03:54:33.115Z", "note": [ { "text": "worklog", "noteType": "worklog", "summary": "test", "logtype": "ClientNote" } ], "orderItem": [ { "id": "5134504144404480", "action": "add", "orderItemRelationship": [ { "id": "3222146583101440", "relationshipType": "PrimaryCi", "@baseType": "fogofa", "@schemaLocation": "bobuvu", "@type": "parujo" } ] } ], "orderRelationship": [ { "id": "5285490846597120", "href": "wabw", "relationshipType": "37.45.132.30", "@baseType": "zorura", "@schemaLocation": "walat", "@type": "silojnuh", "@referredType": "pujnowjo" } ], "relatedParty": [ { "name": "Ethan Hunt", "role": "onbehalfof" }, { "name": "Ethan Hunt", "role": "originator" }, { "name": "RTJK", "role": "affectedcustomer" }, { "role": "sitecontact1", "party": { "givenName": "Ethan", "familyName": "Hunt", "contactMedium": [ { "type": "telephone", "medium": { "number": "6474642347432Ext893364" } }, { "type": "mobile", "medium": { "number": "1234789" } }, { "type": "emailAddress", "medium": { "emailAddress": "ethan@gmail.com" } } ] } }, { "role": "sitecontact2", "party": { "givenName": "Jeff", "familyName": "Jones", "contactMedium": [ { "type": "telephone", "medium": { "number": "514516799145145Ext123234" } }, { "type": "mobile", "medium": { "number": "65678346075890" } } ] } } ], "attachment": [ { "name": "Attachment1", "mimeType": "text", "data": "PD94bWwgdmVyc2lvbj0i=" } ], "state": "NEW", "sourceSystemId": "A478", "@baseType": "fogew", "@schemaLocation": "suce", "@type": "kipeve" }'

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

payload = "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}"

headers = {
   'SECURITY_CREDENTIALS',
    'content-type': "application/json;charset=utf-8",
    'accept': "application/json;charset=utf-8",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("POST", "", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    "content-type: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}");
Request request = new Request.Builder()
  .url("")
  .post(body)
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Path

Post /serviceOrder

Parameters

serviceOrder		The ServiceOrder to be created
Required in body		BellServiceOrder_Create
object

Content-Type		application/json
Optional in header		application/json;charset=utf-8
string

Accept		application/json
Optional in header		application/json;charset=utf-8
Integer

Response

200

Success

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

GET /serviceOrder/{id}

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
   'SECURITY_CREDENTIALS',
    'accept': "application/json;charset=utf-8",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Path

GET /serviceOrder/{id}

Parameters

id		Identifier of the ServiceOrder
Required in path
string

fields		Comma separated properties to display in response

Accept		application/json
Optional in header		application/json;charset=utf-8
string

Response

200

Success

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

PATCH /serviceOrder/{id}

Curl
Python
PHP
Java

Example Request

curl --request PATCH \
  --url '' \
  --header 'accept: application/json;charset=utf-8' \
  --header 'content-type: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS' \
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  --data '{ "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.", "externalId": "715705529925632", "priority": "cebude", "requestedStartDate": "2020-04-08T03:54:33.115Z", "note": [ { "text": "worklog", "noteType": "worklog", "summary": "test", "logtype": "ClientNote" } ], "orderItem": [ { "id": "5134504144404480", "action": "add", "orderItemRelationship": [ { "id": "3222146583101440", "relationshipType": "PrimaryCi", "@baseType": "fogofa", "@schemaLocation": "bobuvu", "@type": "parujo" } ] } ], "orderRelationship": [ { "id": "5285490846597120", "href": "wabw", "relationshipType": "37.45.132.30", "@baseType": "zorura", "@schemaLocation": "walat", "@type": "silojnuh", "@referredType": "pujnowjo" } ], "relatedParty": [ { "name": "Ethan Hunt", "role": "onbehalfof" }, { "name": "Ethan Hunt", "role": "originator" }, { "name": "RTJK", "role": "affectedcustomer" }, { "role": "sitecontact1", "party": { "givenName": "Ethan", "familyName": "Hunt", "contactMedium": [ { "type": "telephone", "medium": { "number": "6474642347432Ext893364" } }, { "type": "mobile", "medium": { "number": "1234789" } }, { "type": "emailAddress", "medium": { "emailAddress": "ethan@gmail.com" } } ] } }, { "role": "sitecontact2", "party": { "givenName": "Jeff", "familyName": "Jones", "contactMedium": [ { "type": "telephone", "medium": { "number": "514516799145145Ext123234" } }, { "type": "mobile", "medium": { "number": "65678346075890" } } ] } } ], "attachment": [ { "name": "Attachment1", "mimeType": "text", "data": "PD94bWwgdmVyc2lvbj0i=" } ], "state": "NEW", "sourceSystemId": "A478", "@baseType": "fogew", "@schemaLocation": "suce", "@type": "kipeve" }'

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

payload = "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}"

headers = {
    'SECURITY_CREDENTIALS',
    'content-type': "application/json;charset=utf-8",
    'accept': "application/json;charset=utf-8",
    --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("PATCH", "", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    "content-type: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{\"description\":\"Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.\",\"externalId\":\"715705529925632\",\"priority\":\"cebude\",\"requestedStartDate\":\"2020-04-08T03:54:33.115Z\",\"note\":[{\"text\":\"worklog\",\"noteType\":\"worklog\",\"summary\":\"test\",\"logtype\":\"ClientNote\"}],\"orderItem\":[{\"id\":\"5134504144404480\",\"action\":\"add\",\"orderItemRelationship\":[{\"id\":\"3222146583101440\",\"relationshipType\":\"PrimaryCi\",\"@baseType\":\"fogofa\",\"@schemaLocation\":\"bobuvu\",\"@type\":\"parujo\"}]}],\"orderRelationship\":[{\"id\":\"5285490846597120\",\"href\":\"wabw\",\"relationshipType\":\"37.45.132.30\",\"@baseType\":\"zorura\",\"@schemaLocation\":\"walat\",\"@type\":\"silojnuh\",\"@referredType\":\"pujnowjo\"}],\"relatedParty\":[{\"name\":\"Ethan Hunt\",\"role\":\"onbehalfof\"},{\"name\":\"Ethan Hunt\",\"role\":\"originator\"},{\"name\":\"RTJK\",\"role\":\"affectedcustomer\"},{\"role\":\"sitecontact1\",\"party\":{\"givenName\":\"Ethan\",\"familyName\":\"Hunt\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"6474642347432Ext893364\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"1234789\"}},{\"type\":\"emailAddress\",\"medium\":{\"emailAddress\":\"ethan@gmail.com\"}}]}},{\"role\":\"sitecontact2\",\"party\":{\"givenName\":\"Jeff\",\"familyName\":\"Jones\",\"contactMedium\":[{\"type\":\"telephone\",\"medium\":{\"number\":\"514516799145145Ext123234\"}},{\"type\":\"mobile\",\"medium\":{\"number\":\"65678346075890\"}}]}}],\"attachment\":[{\"name\":\"Attachment1\",\"mimeType\":\"text\",\"data\":\"PD94bWwgdmVyc2lvbj0i=\"}],\"state\":\"NEW\",\"sourceSystemId\":\"A478\",\"@baseType\":\"fogew\",\"@schemaLocation\":\"suce\",\"@type\":\"kipeve\"}");
Request request = new Request.Builder()
  .url("")
  .patch(body)
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1140779233837056",
  "description": "Imevdam wauza vucubuto pucigiju gewiapu amogunowe gesi vub edudi selile italuno iwuid netin wizuviti gahda owi.",
  "externalId": "715705529925632",
  "priority": "cebude",
  "requestedStartDate": "2020-04-08T03:54:33.115Z",
  "note": [
    {
      "text": "worklog",
      "noteType": "worklog",
      "summary": "test",
      "logtype": "ClientNote"
    }
  ],
  "orderItem": [
    {
      "id": "5134504144404480",
      "action": "add",
      "orderItemRelationship": [
        {
          "id": "3222146583101440",
          "relationshipType": "PrimaryCi",
          "@baseType": "fogofa",
          "@schemaLocation": "bobuvu",
          "@type": "parujo"
        }
      ]
    }
  ],
  "orderRelationship": [
    {
      "id": "5285490846597120",
      "href": "wabw",
      "relationshipType": "37.45.132.30",
      "@baseType": "zorura",
      "@schemaLocation": "walat",
      "@type": "silojnuh",
      "@referredType": "pujnowjo"
    }
  ],
  "relatedParty": [
    {
      "name": "Ethan Hunt",
      "role": "onbehalfof"
    },
    {
      "name": "Ethan Hunt",
      "role": "originator"
    },
    {
      "name": "RTJK",
      "role": "affectedcustomer"
    },
    {
      "role": "sitecontact1",
      "party": {
        "givenName": "Ethan",
        "familyName": "Hunt",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "6474642347432Ext893364"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "1234789"
            }
          },
          {
            "type": "emailAddress",
            "medium": {
              "emailAddress": "ethan@gmail.com"
            }
          }
        ]
      }
    },
    {
      "role": "sitecontact2",
      "party": {
        "givenName": "Jeff",
        "familyName": "Jones",
        "contactMedium": [
          {
            "type": "telephone",
            "medium": {
              "number": "514516799145145Ext123234"
            }
          },
          {
            "type": "mobile",
            "medium": {
              "number": "65678346075890"
            }
          }
        ]
      }
    }
  ],
  "attachment": [
    {
      "name": "Attachment1",
      "mimeType": "text",
      "data": "PD94bWwgdmVyc2lvbj0i="
    }
  ],
  "state": "NEW",
  "sourceSystemId": "A478",
  "@baseType": "fogew",
  "@schemaLocation": "suce",
  "@type": "kipeve"
}

Path

PATCH/serviceOrder/{id}

Parameters

id		Identifier of the ServiceOrder
Required in path
string

serviceOrder		The ServiceOrder to be updated
Required in body		ServiceOrder_Update
object

Content-Type		application/json
Optional in header		application/json;charset=utf-8
string

Accept		application/json
Optional in header		application/json;charset=utf-8
string

Response

202

Accepted

ServiceOrder

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

POST /hub

Curl
Python
PHP
Java

Example Request

curl --request POST \
  --url \
  --header 'accept: application/json;charset=utf-8' \
  --header 'content-type: application/json;charset=utf-8' \
  --header 'SECURITY_CREDENTIALS'\
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  --data '{"callback":"ukoecole","query":"tamseep"}'

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

payload = "{\"callback\":\"ukoecole\",\"query\":\"tamseep\"}"

headers = {
    'SECURITY_CREDENTIALS',
    'content-type': "application/json;charset=utf-8",
    'accept': "application/json;charset=utf-8",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("POST", "", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"callback\":\"ukoecole\",\"query\":\"tamseep\"}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json;charset=utf-8",
    "content-type: application/json;charset=utf-8",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json;charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{\"callback\":\"ukoecole\",\"query\":\"tamseep\"}");
Request request = new Request.Builder()
  .url("")
  .post(body)
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("content-type", "application/json;charset=utf-8")
  .addHeader("accept", "application/json;charset=utf-8")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "1sde46g4g",
  "callback": "bamuowuw",
  "query": "ticogru"
}

Path

POST/hub

Parameters

data		Data containing the callback endpoint to deliver the information
Required in body		EventSubscriptionInput
object

Content-Type		application/json
Optional in header		application/json; charset=utf-8
string

Accept		application/json
Optional in header		application/json; charset=utf-8
string

Response

201

Subscribed

EventSubscription

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

GET /monitor/{monitorId}

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url \
  --header 'accept: application/json' \
  --header 'SECURITY_CREDENTIALS' \
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

 {
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
    'SECURITY_CREDENTIALS',
    'accept': "application/json",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    'SECURITY_CREDENTIALS',
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

 {
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

 {
    "id": "z55a6nQBdX3Vbj8xclMd",
    "externalId": "84009",
    "state": "New",
    "response": {
        "statusCode": "201",
        "body": "{\"id\":\"z55a6nQBdX3Vbj8xclMd\",\"externalID\":\"84009\",\"priority\":\"Low\",\"state\":\"New\"}"
    },
    "href": "https://baseurl/monitor/84009"
}

Path

GET/monitor/{monitorId}

Parameters

monitorId
Required in body
object

Accept		application/json
Optional in header
string

Response

200

The operation was successfull.

Monitor

Ready to get started?