Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Health Check: The link has been rewritten to its master page by check 'P16'.

Table of Contents
outlinetrue
stylenone

...

All GET requests for retrieving data will be done via the SQL endpoint. Please see the SQL for more information on how to create a request. Please see the Data Dictionary for comprehensive detail of available Tables and Data.

In an effort to make the PCR-360 API more flexible, PCR has made the decision to no longer create individual endpoints for all the different data types. Instead, PCR is encouraging Users to use the SQL endpoint with a structured SELECT statement to retrieve exactly the data you want. Please see the SQL endpoint documentation for more information.

...

Field

Required for INSERT

Required for UPDATE

Required for Action Type

Data Type

Options

Notes

type

Yes

Yes


String

ACTION

Required for ALL Service Desk Action Requests

RECID / sda_number

No

Yes*


Integer


*Either “RECID” or “sda_number” are "Conditionally Required" when attempting to UPDATE, but not both. RECID column from SERVICE_DESK_ACTIONS table.

sd_recid / sd_number

Yes*

No


Integer / String


*Either “sd_recid” or “sd_number” are "Conditionally Required" when attempting to INSERT, but not both. RECID column from SERVICE_DESK table.

sd_action

Yes

No


String

ADD, CHG_MOVE, CHG_UPDOWN, CHG_MISC, REMOVE, CHG_SERVICE_ID, CHG_MULTI_LOCATION, CHG_OWNER, TASK

The type of Service Desk Action to be created

location

No*

No*

CHG_MULTI_LOCATION

Integer


RECID of Location.
*Some Services can make the Location "Conditionally Required".
*For Multi Location Services, only Locations already associated to the Service can be used for actions that are not ADD
*For Multi Location Services with 2 or more Locations, Location is "Conditionally Required" for all CHANGE and REMOVE Actions.
*The status of the Location must be Active, and allowed by the Service Catalog.

moveto_location

No

No


Integer


RECID of Location

*Not allowed, and will throw an Error if used on a TASK Action

catalog

Yes

No

ADD, CHG_UPDOWN, TASK

Integer


RECID of Service Catalog

service / service_id

Yes*

No

CHG_UPDOWN, CHG_MOVE, CHG_MISC, REMOVE, CHG_SERVICE_ID, CHG_MULTI_LOCATION, CHG_OWNER

Integer


*Either RECID of Service or SERVICE_ID of Service needs to be provided
*For CHG_SERVICE_ID, CHG_MULTI_LOCATION and CHG_OWNER, the Service must be Active
*Not allowed, and will throw an Error if used on a TASK Action

rating_groupNo*No
String
The LIST CODE for the Rating Group for the Phone Service being used by the Service Desk Action.
Conditionally Required creating Service Desk Actions when using a Serice Catalog of type "Phone".

sla

No

No


Integer

SLAs

RECID of SLA

due_date

No

No


String


Format “YYYY/MM/DD”

service_host / service_host_name

No*

No*


Integer / String

Service Hosts

RECID of Service Host / Name of Service Host / Either RECID or Name should be provided / Conditionally Required when adding an Action to a Phone Service Catalog.

reference

No

No


String



owner_contact

No

No


Integer

Contacts

RECID of Contact. Only a Contact or Department can be Owner, not both.

owner_department

No

No


Integer

Department Hierarchy

RECID of Department. Only a Contact or Department can be Owner, not both.

urgency

No

No


Integer / String

Urgency

Can be RECID or VALUE

start_date

No

No


String


Format: “YYYY/MM/DD”

gla

No

No


Integer


Multiple are sent comma delimited. Example: gla1,gla2,gla3

gla_type

Only if gla is sent

Only if gla is sent


String

Options: Default, Usage, Equipment and Labor

Multiple are sent comma delimited. Example: type1,type2,type3.

gla_percent

Only if gla is sent

Only if gla is sent


Integer

The total of all percentages for a single type must be 100

Mutliple are sent comma delimited. Example: percent1,percent2,percent3.

sdc_recidNoNo
Integer
Passing an SDC will allow an Action to be created with default Workflows, Equipment and Charges. RECID column from SERVICE_DESK_ACTIONS SDC table.
new_serviceNoNoCHG_SERVICE_IDInteger
The new Service ID for the Service being changed.
One of the following must be true for the new Service ID:
  1. existing & available & New Service ID must be in the same Catalog or an ancestor of the Catalog as the original Service ID (NOT normalized type) & not in a pool
  2. existing & available & New Service ID must be in the same Catalog or an ancestor of the Catalog as the original Service ID (NOT normalized type) & in a pool
    • if the new Service ID specified is an existing Service and the Catalog for the original Service specified on a pool then the new Service ID must be in the same pool
  3. doesn't exist
auth_code_typeYes*NoADDInteger

Lists 

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue

RECID of Auth Code Type for an authcode service.
*Required when attempting to INSERT an authcode Service.
classes_of_serviceYes*NoADDIntegerExampleRECID of Class of Service for an authcode service.
*Required when attempting to INSERT a new auth_code_type record.
bandwidthNoNo
Integer

Lists 

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue

RECID of Bandwidth for a data/backbone service.
owner_typeNoNoCHG_OWNERString'contact', 'department'The type of the Owner, either a Contact or a Department.
ownerNoNoCHG_OWNERInteger
RECID of the Owner. Must be Active.

udf_IDENTIFIER

No

No


Mixed


IDENTIFIER is the unique identifier string given to each UDF

...

For full documentation on SDCs, see the Service Desk Classification wiki page.

Ordering from Service Pools

...

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT

Field

Value

type

ACTION

sd_number

SO201804031

sd_action

ADD

catalog

879

due_date

2019/12/31

CHG_MOVE Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT
FieldValue
typeACTION
sd_numberSO201804031
sd_actionCHG_MOVE
service1324
due_date2019/12/31

CHG_UPDOWN Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT
FieldValue
typeACTION
sd_numberSO201804031
sd_actionCHG_UPDOWN
catalog879
service1324
due_date2019/12/31

CHG_MISC Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT
FieldValue
typeACTION
sd_numberSO201804031
sd_actionCHG_MISC
service1324
due_date2019/12/31

REMOVE Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT
FieldValue
type

ACTION

sd_numberSO201804031
sd_actionREMOVE 
service1324
due_date2019/12/31

CHG_SERVICE_ID Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT

Field

Value

type

ACTION

sd_numberSO201804031
sd_actionCHG_SERVICE_ID 
service1324
new_service5555555555
due_date2019/12/31

CHG_MULTI_LOCATION Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT

Field

Value

type

ACTION

sd_numberSO201804031
sd_action

CHG_MULTI_LOCATION 

service1324
location8675309
due_date2019/12/31

CHG_OWNER Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT

Field

Value

type

ACTION

sd_numberSO201804031
sd_action

CHG_OWNER 


service1324
owner_typecontact
owner357
due_date2019/12/31

TASK Action Example
Toggle cloak

Cloak
Code Block
languagexml
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT

Field

Value

type

ACTION

sd_numberSO201804031
sd_action

TASK


due_date2019/12/31
catalog52

Results
Toggle cloak

...

Please see the wiki entry for Service Desk Actions for detailed information about where this data can be found.

...