Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: made required red

Table of Contents
outlinetrue
stylenone

...

Type

Description

Extra Parameters*

Searchable

Results

CONTACTS

Retrieve available Contacts

CTYPE - Type of contact. Example: "worker"

yes

Contacts

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <contacts>
            <item>
                <RECID>809</RECID>
                <SERVICE_REP>Doe, John</SERVICE_REP>
                <STATUS>1</STATUS>
                <CONTACT_TYPE_LISTS_RECID>1147</CONTACT_TYPE_LISTS_RECID>
                <C_TITLE_VALUE/>
                <C_TITLE_CODE/>
                <CTYPE_CONTACT_TYPE_VALUE>User</CTYPE_CONTACT_TYPE_VALUE>
                <CTYPE_CONTACT_TYPE_CODE>USER</CTYPE_CONTACT_TYPE_CODE>
            </item>
        </contacts>
    </servicedesk>




DEPTHIER

Retrieve available Departments


Coming Soon

Department Hierarchy

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <depthier>
            <item>
                <RECID>24</RECID>
                <DH_NAME>Facilities</DH_NAME>
                <STATUS>1</STATUS>
                <DEFAULT_SLA_DESC/>
                <DEFAULT_INCI_SLA_DESC/>
                <BG_NAME>Admin</BG_NAME>
                <DEPT_HIERARCHY_PATH>FM</DEPT_HIERARCHY_PATH>
                <DEPT_HIERARCHY_PATH_TOOLTIP>FM</DEPT_HIERARCHY_PATH_TOOLTIP>
                <NAME_AND_BG>FM - Admin</NAME_AND_BG>
            </item>
        </depthier>
    </servicedesk>




EQP_CATALOG

Retrieve available Equipment Catalogs


yes

Equipment Catalog

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>64</count>
        <total_count>64</total_count>
        <eqp_catalog>
            <item>
                <RECID>56</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2013-08-20 13:56:56</MODIFIED_DATE>
                <MODIFIED_BY>LOrgana</MODIFIED_BY>
                <STATUS>1</STATUS>
                <PART_NUMBER>Test 1</PART_NUMBER>
                <PART_NUM_BARCODE>2939473020239</PART_NUM_BARCODE>
                <DESCRIPTION>Blaster</DESCRIPTION>
                <MANUFACTURER>Integrated Galactic Blaster Corp.</MANUFACTURER
                <MANU_PART_NUM>T23</MANU_PART_NUM>
                <CATALOG_DESCRIPTION>The last line of defense that you will ever need.</CATALOG_DESCRIPTION>
                <CATEGORY>0</CATEGORY>
                <PRORATE>0</PRORATE>
                <ASSIGNABLE>1</ASSIGNABLE>
                <BILLABLE>0</BILLABLE>
                <CABLING_EQUIPMENT>1</CABLING_EQUIPMENT>
                <ASSET>0</ASSET>
                <LOCATION_REQUIRED>0</LOCATION_REQUIRED>
                <ORDERABLE>1</ORDERABLE>
                <CONSUMABLE>0</CONSUMABLE>
                <PROVISIONED>0</PROVISIONED>
                <REVENUE_GLA_RECID>42</REVENUE_GLA_RECID>
                <REVENUE_OB_CODES_RECID>6</REVENUE_OB_CODES_RECID>
                <EXPENSE_OB_CODES_RECID>6</EXPENSE_OB_CODES_RECID>
                <WORKER_INSTALL_TIME/>
                <WORKER_REMOVE_TIME/>
                <MAX_QUANTITY/>
                <PARENT_EQP_CATALOG_RECID>28</PARENT_EQP_CATALOG_RECID>
                <WARRANTY_LENGTH_LISTS_RECID/>
                <HEIGHT/>
                <WIDTH/>
                <SLOTS/>
                <UNIT_LISTS_RECID>1339</UNIT_LISTS_RECID>
                <HAS_UNITS>0</HAS_UNITS>
                <CONTIGUOUS>0</CONTIGUOUS>
                <CM_MODEL/>
                <BILLING_GROUP_RESTRICT/>
                <LOCATION_RESTRICT>
                    <item>111</item>
                </LOCATION_RESTRICT>
            </item>
        </eqp_catalog>
    </servicedesk>




CHARGE_CATALOG

Retrieve available Charge Catalogs


yes

Charge Catalog

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>64</count>
        <total_count>64</total_count>
        <charge_catalog>
            <item>
                <RECID>167</RECID>
                <NAME>Starship Detailing</NAME>
                <DESCRIPTION>1-time charge for cleaning of starships</DESCRIPTION>
                <AMOUNT>126587</AMOUNT>
                <CHARGE_TYPE_LISTS_RECID>1981</CHARGE_TYPE_LISTS_RECID>
                <EXPENSE_TYPE_LISTS_RECID>1182</EXPENSE_TYPE_LISTS_RECID>
                <PARENT_CHRG_CATALOG_RECID/>
                <REVENUE_GLA_RECID>1</REVENUE_GLA_RECID>
                <USE_QUANTITY>1</USE_QUANTITY>
                <TAXABLE>0</TAXABLE>
                <ALLOW_OVERRIDE>1</ALLOW_OVERRIDE>
                <CC_CHARGE_TYPE_VALUE>1 time</CC_CHARGE_TYPE_VALUE>
                <CC_CHARGE_TYPE_CODE>1_TIME</CC_CHARGE_TYPE_CODE>
                <CC_EXPENSE_TYPE_VALUE>Default</CC_EXPENSE_TYPE_VALUE>
                <CC_EXPENSE_TYPE_CODE>DEFAULT</CC_EXPENSE_TYPE_CODE>
            </item>
        </charge_catalog>
    </servicedesk>




PRCODE

Retrieve available Problem Codes


no

Problem Code

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <prcode>
            <item>
                <RECID>3</RECID>
                <PRCODE>General</PRCODE>
            </item>
        </prcode>
    </servicedesk>




RESCODE

Retrieve available Resolution Codes


no

Resolution Code

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <rescode>
            <item>
                <RECID>1</RECID>
                <RESCODE>Replaced Unit</RESCODE>
            </item>
        </rescode>
    </servicedesk>




CSRS

Retrieve available Customer Service Representatives (CSR)


no

CSR

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
<servicedesk> <status>success</status> <page>1</page> <count>20</count> <total_count>20</total_count> <csrs> <item> <RECID>545</RECID> <SERVICE_REP>Doe, John</SERVICE_REP> <STATUS>1</STATUS> <CONTACT_TYPE_LISTS_RECID>1151</CONTACT_TYPE_LISTS_RECID> <C_TITLE_VALUE/> <C_TITLE_CODE/> <CTYPE_CONTACT_TYPE_VALUE>Service Rep</CTYPE_CONTACT_TYPE_VALUE> <CTYPE_CONTACT_TYPE_CODE>SERVICE_REP</CTYPE_CONTACT_TYPE_CODE> </item> </csrs> </servicedesk>




SD_STATUS

Retrieve available Service Desk Statuses


no

SD Status

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <sd_status>
            <RECID>1310</RECID>
            <VALUE>Denied</VALUE>
        </sd_status>
    </servicedesk>




SDTYPES

Retrieve available Service Desk Types (Some may not be currently valid for creating or updating SD records via the API)


no

SD Types

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <sdtypes>
            <CODE>sd-incident-report</CODE>
            <VALUE>Incident</VALUE>
        </sdtypes>
    </servicedesk>




UDFS

Retrieve available User Defined Fields (UDF)

SDTYPE - Retrieve UDFs for only a specific SD Type
SORT - Order the results ASC by a specific field

no

UDF

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <udfs>
            <item>
                <UDF_RECID>10</UDF_RECID>
                <LABEL>test</LABEL>
                <FIELD_TYPE>Text</FIELD_TYPE>
                <REQUIRED>0</REQUIRED>
                <DESCRIPTION>A UDF Field</DESCRIPTION>
                <UDF_ORDER>1</UDF_ORDER>
                <FORM_ELEMENT_WIDTH/>
                <FORM_ELEMENT_HEIGHT/>
                <FORM_ELEMENT_TEXT_WIDTH/>
                <SD_TYPE>Service Request</SD_TYPE>
                <VERIFY>0</VERIFY>
                <AGING_PERSISTENT>0</AGING_PERSISTENT>
                <UDTABLE_DEF/>
                <TYPES/>
            </item>
        </udfs>
    </servicedesk>




WORKGROUPS

Retrieve available Workgroups


no

Workgroups

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>10</count>
        <total_count>10</total_count>
        <workgroups>
            <item>
                <RECID>21</RECID>
                <VALUE>Cable Plant</VALUE>
            </item>
        </workgroups>
    </servicedesk>




LABOR_TYPE

Retrieve available Labor Types


no

Labor Types

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>4</count>
        <total_count>4</total_count>
        <labor_type>
            <item>
                <RECID>1220</RECID>
                <VALUE>Regular</VALUE>
            </item>
        </labor_type>
    </servicedesk>




SD_CHRG_ACTION

Retrieve available Service Desk Charge Actions


no

SD Charge Actions

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>4</count>
        <total_count>4</total_count>
        <sd_chrg_action>
            <item>
                <RECID>1220</RECID>
                <VALUE>Regular</VALUE>
            </item>
        </sd_chrg_action>
    </servicedesk>




URGENCY

Retrieve available Service Desk Urgency values


no

SD Urgency

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
    <servicedesk>
        <status>success</status>
        <page>1</page>
        <count>4</count>
        <total_count>4</total_count>
        <urgency>
            <item>
                <RECID>561</RECID>
                <VALUE>Low</VALUE>
            </item>
        </urgency>
    </servicedesk>




AUTH_CODE_TYPERetrieve available Auth Code Types
no

SD Auth Code

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
<servicedesk>
    <status>success</status>
    <page>1</page>
    <count>3</count>
    <total_count>3</total_count>
    <auth_code_type>
        <item>
            <RECID>22</RECID>
            <VALUE>1</VALUE>
        </item>
        <item>
            <RECID>23</RECID>
            <VALUE>2</VALUE>
        </item>
        <item>
            <RECID>24</RECID>
            <VALUE>3</VALUE>
        </item>
    </auth_code_type>
</servicedesk>




BANDWIDTHRetrieve available Bandwidth values
no

SD Bandwidth

Toggle cloak

Cloak


Code Block
languagexml
linenumberstrue
<servicedesk>
    <status>success</status>
    <page>1</page>
    <count>1</count>
    <total_count>1</total_count>
    <bandwidth>
        <item>
            <RECID>25</RECID>
            <VALUE>1 GBPS</VALUE>
        </item>
    </bandwidth>
</servicedesk>




...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

recid

143658

type

SO

csr1

Results

If the request is successful, the SD Number will returns as follows:

Toggle cloak

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

recid

267870

prob_code4
owner1
owner_type"contact"

type

IN

csr1

...

Field

Required

Data Type

Options

Default

Notes

charge_catalog

no

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue



Record ID of the applicable Charge.

charge_description

no

String



The details or description of the Charge on the Estimate

chrg_quantity

no

Integer


1

Quantity of Charge to be used.

prorate

no

Integer

1 or 0

0

Should the Charge be prorated when activated

override_amount

no

Decimal



If allowed by the selected Charge, overrides the default amount from the Charge.

eqp_catalog

no

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue



Record ID of the Equipment Catalog item to added to the Estimate.

eqp_quantity

no

Integer


1

Quantity of the Equipment to be added to the Estimate.

eqp_billable

no

Integer

1 or 0


Mark whether the Equipment item is billable.

labor_type

yes*

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue



Type of Labor to be added.
*Only required Required when adding Labor to the Estimate (when "workgroup" field is provided).

workgroup

no

Integer

Value Lookups:

Toggle cloak

Cloak

Insert excerpt
API
API
nopaneltrue



Record ID of the Workgroup to be associated with the Labor record on the Estimate.

labor_description

no

String



Description to give the Labor record.

hours

yes*

String



Hours to be assigned to the labor. Use "h" for hours and "m" for minutes. Example: "1h 30m"
*Only required Required when adding labor to the estimate (when "workgroup" field is provided).

rate

no

Decimal



Rate to be billed for Labor. If not provided, default rate from Workgroup will be used.

labor_billable

no

Integer

1 or 0


Mark whether the Labor item is billable.

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

recid

355989

type

ES

csr1

Results

If the request is successful, the SD Number will be returned as follows:

Toggle cloak

...

Field

Required

Data Type

Options

Default

Notes

sd_recid

yes*

Integer



*Either sd_recid or sd_number are conditionally Required, but not both. RECID column from SERVICE_DESK table.

sd_number

yes*

String



*Either sd_recid or sd_number are conditionally Required, but not both. The Number of the Service Desk item that the UDF is for.

sda_recidno*Integer

RECID of the Service Desk Action. If "sda_recid" is provided, "sd_recid" and "sd_number" are not required Required.

sda_numberno*String

Service Desk Action Number for the Action. "sda_number" can be provided instead of "sda_recid" IF "sd_recid" or "sd_number" are provided.

udf_IDENTIFIER

yes*

Mixed



IDENTIFIER is the unique Identifier of the UDF to assign the value to. Example: udf_LEGACYNUM=value
*A single UDF parameter is required Required, but not all of them

action_udf_IDENTIFIERyes*Mixed

IDENTIFIER of UDF belonging to a Service preceded by “action_udf_”. Example: action_udf_FIELD123
Provided value will be validated against UDF’s data type requirements and used if acceptable.

*A single UDF parameter is required Required, but not all of them

action_udf_RECIDyes*Integer

RECID of UDF belonging to a Service preceded by “action_udf_”. Example: action_udf_FIELD123
Provided value will be validated against UDF’s data type requirements and used if acceptable.

*A single UDF parameter is required Required, but not all of them

NOTES

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

sd_recid

5434

type

SO

udf_IDENTIFIER1

...

Field

Required

Data Type

Options

Default

Notes

typeyesString

type must be REMARKS

sd_recid

yes

Integer



RECID column from SERVICE_DESK table.

remarks

yes

String



The remark to add to the service

sda_recidnoInteger

*ConditionallyRequired for use on a Service Desk Action. RECID column from SERVICE_DESK_ACTIONS table.

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

sd_recid

999

typeREMARKS
remarksThis is a Remark from the API

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

estimate_recid

56487
charge_catalog1
typeEST_CHARGES

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

estimate_recid

55073
labor_type

Regular

workgroup1
hours1h 45m
typeEST_CHARGES

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

estimate_recid

78451
eqp_catalog

1

eqp_quantity1
eqp_billable1
typeEST_CHARGES

...

Field

Required

Data Type

Options

Default

Notes

type

yes

String


GLA

type=GLA is required Required

sd_recid

yes*

Integer



RECID column from SERVICE_DESK table.
*See NOTE below

sd_number

yes*

String



The Number of the Service Desk item that the UDF is for.
*See NOTE below

sda_recidno*Integer

RECID of the Service Desk Action. If "sda_recid" is provided, "sd_recid" and "sd_number" are not required Required.

sda_numbernoString

Service Desk Action Number for the Action. "sda_number" can be provided instead of "sda_recid" IF "sd_recid" or "sd_number" are provided.

action_default_gla

no*

String or Integer



If a single GLA is sent with a Service Desk request, the value of this is RECID of the GLA. If multiple GLAs are sent with a Service Desk request OR request made directly to the Service Desk GLA POST, this param is "1" or "0" (true/false). If multiple GLAs sent, then these are comma-separated corresponding to the GLAs.

gla

yes

Mixed



A single GLA RECID or comma-separated GLA RECIDs

gla_type

yes

String



A single GLA type or comma-separated GLA types. Example: "Default" or "Usage"

gla_percent

yes

Mixed



A single number of "100" or comma-separated numbers that equal 100. Example: "50,50"

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

sd_recid

78451

gla

1

gla_typeDefault
gla_percent100
typeGLA

...

Below is the proper format for making a separate request.

Note: "type=EQUIPMENT" to indicate that this is to create an Equipment record.

...

Field

Required

Data Type

Options

Default

Notes

type

yes

String



type=EQUIPMENT is Required

sd_recid

yes*

Integer



RECID column from SERVICE_DESK table.
*See NOTE below

sd_number

yes*

String



The Number of the Service Desk item that the Equipment is for.
*See NOTE below

sda_recidno*Integer

RECID for the Service Desk Action. If "sda_recid" is provided, "sd_recid" and "sd_number" are not required Required.

sda_numbernoString

Service Desk Action Number for the Action. "sda_number" can be provided instead of "sda_recid" IF "sd_recid" or "sd_number" are provided.
equipment noInteger

RECID for the Equipment to be added. Used only for Cabling and Asset type Equipment.
equipment _idno*Integer

Equipment ID for the Equipment. Conditionally Required for Cabling type Equipment.
to_location noInteger

RECID of the Location the Equipment will be moved to.
from_location noInteger

RECID of the Location the Equipment will be moved from.
qty yesInteger

Quantity of the Equipment to be added
billable no

Integer

1 or 0

defaulted to Catalog setting

Mark whether the Equipment item is Billable.

sda_recid no*Integer

RECID column from SERVICE_DESK_ACTIONS table.
*Required if appending to an Action.

sda_numberno*String

The Service Desk Action Number.
asset_tagno*String

The Asset Tag for the Equipment. Conditionally Required for Asset type Equipment.
override_glanoInteger

RECID of the GLA to override billing for this Equipment.
eqp_catalogno*Integer

Equipment Catalog RECID
*Required if not Cabling or Asset equipment

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

sd_recid

78451

qty

1

typeEQUIPMENT
eqp_catalog1

...

Below is the proper format for making a separate request.

Note: "type=LABOR" to indicate that this is to create an Equipment record.

...

Field

Required

Data Type

Options

Default

Notes

typeyesString

type=LABOR is Required
sd_recidyes*Integer

RECID column from SERVICE_DESK table.

*See Note Below.

sd_number yes*String

Service Desk Number for the Service Desk Item.

*See Note Below

sda_recidno*Integer

RECID for the Service Desk Action. If "sda_recid" is provided, "sd_recid" and "sd_number" are not required Required.

sda_numbernoString

Service Desk Action Number for the Action. "sda_number" can be provided instead of "sda_recid" IF "sd_recid" or "sd_number" are provided.
labor_typeyesString"Regular", "OT", "2xOT"
Type of Labor activity. This is a case-sensitive field.
dateyesString

Date the Labor action was performed on. YYYY/MM/DD format.
hoursyesDecimal

Hours to be assigned to the Labor. must be sent in decimal hours (0.5 is 30 min)
workflownoInteger

Recid for the Workflow
workgroupyesInteger

Recid for the Workgroup. Workgroup must be Active.
workeryesInteger

Recid for the Worker. Worker must be an Active Contact with Contact Type = Worker. Worker must be part of provided Workgroup.
flate_ratenoDecimal
NULLRate to be billed for Labor. Only zero or positive dollar amounts are allowed.
descriptionnoString

Description to give the Labor record
billableyesBoolean1 (True), 0 (False)
Mark whether the Labor action is billable

...

  • "sd_recid" or "sd_number" are Conditionally Required. The use of one is Required, but not both.
  • "sda_number" or "sda_recid" are Conditionally Required. The use of one is Required, but not both.

  • "sd_recid", "sd_number" and "sda_number" can be omitted if "sda_recid" is provided

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

typeLABOR
sd_recid66116
labor_typeRegular
date2019/04/25
hours1.25
workgroup1
worker1
billable0

...

Key

Value

Content-Type

application/json

Pcr-Html-Encoded

TRUE

Body:

Key

Value

typeWO
catalog7394
sourceWeb
csr1

Results

...

FieldRequiredData TypeOptionsDefaultNotes
typeyesString

type=WORKFLOW
recidnoInteger

required if updating

sd_recid

yes*

Integer



*Either sd_recid or sd_number are conditionallyRequired, but not both. RECID column from SERVICE_DESK table.

sd_number

yes*

String



*Either sd_recid or sd_number are conditionallyRequired, but not both. The Number of the Service Desk item.

sda_recidno*Integer

RECID for the Service Desk Action Number. If "sda_recid" is provided, "sd_recid" and "sd_number" are not required Required.

sda_numbernoString

Service Desk Action Number for the Action. "sda_number" can be provided instead of "sda_recid" IF "sd_recid" or "sd_number" are provided.
sequenceyesInteger

needs to be higher than highest completed sequence

if status is complete, needs to be higher than lowest pending

workgroupyesInteger

Record ID of the Workgroup 
workernoInteger

Record ID of the Worker. Worker must be an Active Contact with Contact type = Worker. Worker must be part of provided Workgroup.
scheduled_datenoString

The date Workflow is scheduled to begin.
scheduled_end_datenoString

The date Workflow is scheduled to end.
billableyesInteger1 or 0
Mark wether Workflow is billable
statusyesStringPENDING, COMPLETE, HOLD, VOID
Current status of Workflow
notesnoString

Editable notes for the Workflow
estimated_timenoString

Example 1.5 is equivalent to 1 hour 30 minutes
start_datenoString

The date the Workflow was started
completed_datenoString

The date the Workflow was completed.
activity_remarksnoString

Required if status is hold. 

NOTES:

  • "sd_recid" or "sd_number" are Conditionally Required. The use of one is Required, but not both.
  • "sda_number" or "sda_recid" are Conditionally Required. The use of one is Required, but not both.

  • "sd_recid", "sd_number" and "sda_number" can be omitted if "sda_recid" is provided

...

Attachments can be added to Service Desk Items either on there their own, or as a part of any normal creation or update of an existing Service Desk Item.

...

FieldRequiredData TypeOptionsDefaultNotes
typenoStringATTACHMENT
Can be used to add an attachment when creating, or updating any Service Desk Action
filesyesarray

The file(s) to be attached. 

'files' is an array with infinite number of sub-arrays.  Each sub-array has keys of 'filename' (the file's name) and 'data' (the base64 encoded data for the file).

sd_recidyes*Integer

*Either sd_recid or sd_number are conditionallyRequired, but not both. RECID column from SERVICE_DESK table.

sd_number

yes*

String



*Either sd_recid or sd_number are conditionallyRequired, but not both. The Number of the Service Desk item.

sda_recidno*Integer

If "sda_recid" is provided,   "sd_recid" and "sd_number" are not required Required.

sda_numbernoString

"sda_number" can be provided instead of "sda_recid" IF "sd_recid" or "sd_number" are provided.

...

  • a User can provide just the 'sd_recid' to attach the file to the Service Desk item and if the 'sda_recid' is provided, it will attach it to the Action.
  • "sd_recid" or "sd_number" are Conditionally Required. The use of one is Required, but not both.
  • "sda_number" or "sda_recid" are Conditionally Required. The use of one is Required, but not both.

  • "sd_recid", "sd_number" and "sda_number" can be omitted if "sda_recid" is provided

...