Table of Contents | ||||
---|---|---|---|---|
|
...
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 | ||
sd_recid / sd_number | Yes* | No | Integer / String | *Either “sd_recid” or “sd_number” are "Conditionally Required" when attempting to INSERT, but not both | ||
sd_action | Yes | No | String | ADD, CHG_MOVE, CHG_UPDOWN, CHG_MISC, REMOVE, CHG_SERVICE_ID, CHG_MULTI_LOCATION, CHG_OWNER | The type of Service Desk Action to be created | |
location | No* | No* | CHG_MULTI_LOCATION | Integer | RECID of Location. | |
moveto_location | No | No | Integer | RECID of Location | ||
catalog | Yes | No | ADD, CHG_UPDOWN | 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 | |
sla | No | No | Integer | RECID of SLA | ||
due_date | No | No | String | Format “YYYY/MM/DD” | ||
service_host / service_host_name | No* | No* | Integer / String | RECID of Service Host / Name of Service Host / Either RECID or Name should be provided / *Some Services CService Host | ||
reference | No | No | String | |||
owner_contact | No | No | Integer | RECID of Contact. Only a Contact or Department can be Owner, not both. | ||
owner_department | No | No | Integer | RECID of Department. Only a Contact or Department can be Owner, not both. | ||
urgency | No | No | Integer / String | 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_recid | No | No | Integer | Passing an SDC will allow an Action to be created with default Workflows, Equipment and Charges. | ||
new_service | No | No | CHG_SERVICE_ID | Integer | The new Service ID for the Service being changed. One of the following must be true for the new Service ID:
| |
auth_code_type | Yes* | No | ADD | Integer | .Service Desk API Calls v2.1.4.7#Lists | Recid of Auth Code Type for an authcode service. *Required when attempting to INSERT an authcode Service. |
classes_of_service | Yes* | No | ADD | Integer | Example | Recid of Class of Service for an authcode service. *Required when attempting to INSERT a new auth_code_type record. |
bandwidth | No | No | Integer | .Service Desk API Calls v2.1.4.7#Lists | Recid of Bandwidth for a data/backbone service. | |
owner_type | No | No | CHG_OWNER | String | 'contact', 'department' | The type of the Owner, either a Contact or a Department. |
owner | No | No | CHG_OWNER | Integer | Recid of the Owner. Must be Active. | |
udf_IDENTIFIER | No | No | Mixed | IDENTIFIER is the unique identifier string given to each UDF |
...
Cloak | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CHG_MOVE Action Example
Toggle cloak |
---|
Cloak | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CHG_UPDOWN Action Example
Toggle cloak |
---|
Cloak | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CHG_MISC Action Example
Toggle cloak |
---|
Cloak | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
REMOVE Action Example
Toggle cloak |
---|
Cloak | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CHG_SERVICE_ID Action Example
Toggle cloak |
---|
Cloak | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CHG_MULTI_LOCATION Action Example
Toggle cloak |
---|
Cloak | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CHG_OWNER Action Example
Toggle cloak |
---|
Cloak | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Results
Toggle cloak |
---|
Cloak | |||||
---|---|---|---|---|---|
If the request is successful, the RECID of the Action will be returned as follows:
|
...
Code Block | ||
---|---|---|
| ||
POST http://DOMAIN/api/API_KEY/servicedesk.OUTPUT?TYPE=GLA&field1=value1 ... |
Available Fields
...