Component List v1.0 - EN & JP

Blue Prism Connectors for ServiceNow - Component List (English) v1.
0
GET - Retrieve Last Updated: 2023-09-28
POST - Create
■ServiceNow Change Management API
PUT,PATCH - Update
Each action is created using the Change Management API of the ServiceNow REST API. For more details, please refer to the official ServiceNow documentation.
DELETE - Delete
(Note: The link below is applicable to release version "Tokyo." Please refer to the appropriate version of the documentation depending on your environment.)
https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/change-management-api.html
Actions Description Input Parameter Output Parameter Web API settings

(* denotes required fields) Method URL Path Body Content Headers Response
Create Standard Change Request By Creates one standard change request based on an *standard_change_template_id (Text): Unique identifier of the standard change Response_Content (Text): A JSON value containing response information related to the POST /sn_chg_rest/change/standard/[standard_change_templ None Accept:application/json None
TemplateId existing standard change template as specified by the template on which to base the new standard change request (from request. ate_id]?[name-value pairs]
passed-in template sys_id. Multiple standard change [std_change_record_producer] table). HTTP Status Code (Text): HTTP Status code returned in response.
request creations within a single call is not supported. *name-value pairs (Text): Fields within the specified standard change template to Response Headers (Collection): Collection of headers data returned in response.
modify when creating the request. The key is the field name within the template and the
value is the information to populate in the field.
*ServiceNow Instance (Text): The name of the ServiceNow instance being used.
Retrieve Standard Change Request Retrieves one or more standard change requests based *order (Text): Field by which to sort the returned change requests. Default: number. Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/standard?order=[order]&sysparm None Accept:application/json None
on the specified criteria. sysparm_limit (Text): Maximum number of records to return. Unusually large request. _limit=[sysparm_limit]&sysparm_offset=[sysparm_offse
sysparm_limit values can impact system performance. For requests that exceed this HTTP Status Code (Text): HTTP Status code returned in response. t]&sysparm_query=[sysparm_query]&[name-value
number of records, use the sysparm_offset parameter to paginate record retrieval. Response Headers (Collection): Collection of headers data returned in response. pairs]&textSearch=[textSearch]
sysparm_offset (Text): Starting record index for which to begin retrieving records. Use
this value to paginate record retrieval. This functionality enables the retrieval of all
records, regardless of the number of records, in small manageable chunks.
sysparm_query (Text): Encoded query used to filter the result set.
name-value pairs (Text): Name-value pairs to use to filter the result set. The name is
the field on which the specified value is filtered. This parameter is mutually exclusive with
sysparm_query.
textSearch (Text): String to use to search all standard change request record fields. This
search uses ServiceNow full text search platform functionality and defaults to
IR_AND_OR_QUERY.
Retrieve Standard Change Request By SysId Retrieves the standard change request identified by the *sys_id (Text): Unique identifier of the standard change request to retrieve from the Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/standard/[sys_id] None Accept:application/json None
specified sys_id. [change_request] table. request.
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. HTTP Status Code (Text): HTTP Status code returned in response.
Response Headers (Collection): Collection of headers data returned in response.
Update Standard Change Request By SysId Updates the standard change request identified by the *sys_id (Text): Unique identifier of the change request to modify (from [change_request] Response_Content (Text): A JSON value containing response information related to the PATCH /sn_chg_rest/change/standard/[sys_id]?[name-value Template Content-Type:application/json None
specified sys_id with the parameters in the request body table). request. pairs] [body]
or in the URL. name-value pairs (Text): Name-value pairs for the fields to update. Request body HTTP Status Code (Text): HTTP Status code returned in response.
parameters override URL parameters. However, required parameters must be specified in Response Headers (Collection): Collection of headers data returned in response.
the URL.
body (Text): Optional parameters. For more details, please refer to the official
documentation.
Calculate Change Impact Risk Calculates the risk and impact of the specified standard *sys_id (Text): Unique identifier of the standard change to evaluate (from Response_Content (Text): A JSON value containing response information related to the PATCH /sn_chg_rest/change/[sys_id]/risk None Accept:application/json None
change based on an evaluation of the risk conditions. If [change_request] table). request.
the Change Risk Assessment plugin is installed, it also *ServiceNow Instance (Text): The name of the ServiceNow instance being used. HTTP Status Code (Text): HTTP Status code returned in response.
calculates the cumulative highest risk once the risk Response Headers (Collection): Collection of headers data returned in response.
assessment is complete.
Delete Standard Change Request Deletes the standard change request identified by the *sys_id (Text): Unique identifier of the standard change request to delete [from Response_Content (Text): A JSON value containing response information related to the DELETE /sn_chg_rest/change/standard/[sys_id] None Accept:application/json None
specified sys_id. change_request table]. request.
Retrieve Standard Change Template Retrieves one or more standard change templates based order (Text): Field by which to sort the returned standard change templates. Default: Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/standard/template?order=[order] None Accept:application/json None
on the specified criteria. number.Note: The "number" field does not exist in the template, so if the "order" is left request. &sysparm_limit=[sysparm_limit]&sysparm_offset=[sysp
blank, there may be cases where the retrieval count is 0. In these instances, you can HTTP Status Code (Text): HTTP Status code returned in response. arm_offset]&sysparm_query=[sysparm_query]&[name-
normally retrieve the information by setting the "order" to "false." Response Headers (Collection): Collection of headers data returned in response. value pairs]&textSearch=[textSearch]
sysparm_limit (Text): Maximum number of records to return. Unusually large
sysparm_limit values can impact system performance. For requests that exceed this
number of records, use the sysparm_offset parameter to paginate record retrieval.
Default: 500.
sysparm_query.
textSearch (Text): String to use to search all standard change request record fields. This
IR_AND_OR_QUERY.
Retrieve Standard Change Template By Retrieves the standard change template identified by *sys_id (Text): Unique identifier of the standard change template to retrieve from the Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/standard/template/[sys_id] None Accept:application/json None
SysId the specified sys_id. [std_change_record_producer] table. request.
Create Normal Change Request Creates one normal change request based on the *key value pairs (Text): Fields to modify when creating the request. The key is the field Response_Content (Text): A JSON value containing response information related to the POST /sn_chg_rest/change/normal?[key value pairs] None Accept:application/json None
default normal change request record. Multiple normal name within the template and the value is the information to populate in the field. request.
change request creations within a single call is not *ServiceNow Instance (Text): The name of the ServiceNow instance being used. HTTP Status Code (Text): HTTP Status code returned in response.
supported. Response Headers (Collection): Collection of headers data returned in response.
1 / 14 ページ
Blue Prism Connectors for ServiceNow - Component List (English) v1.0
POST - Create
PUT,PATCH - Update
DELETE - Delete

Retrieve Normal Change Request Retrieves one or more normal change requests based on order (Text): Field by which to sort the returned change requests. Default: number Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/normal?order=[order]&sysparm_li None Accept:application/json None
the specified criteria. sysparm_limit (Text): Maximum number of records to return. Unusually large request. mit=[sysparm_limit]&sysparm_offset=[sysparm_offset]
sysparm_limit values can impact system performance. For requests that exceed this HTTP Status Code (Text): HTTP Status code returned in response. &sysparm_query=[sysparm_query]&[name-value
Default: 500
sysparm_query.
textSearch (Text): String to use to search all normal change request record fields. This
IR_AND_OR_QUERY.
Retrieve Normal Change Request By SysId Retrieves the normal change request identified by the *sys_id (Text): Unique identifier of the normal change request to retrieve from Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/normal/[sys_id] None Accept:application/json None
specified sys_id. [change_request] table. request.
Update Normal Change Request By SysId Updates the normal change request identified by the *sys_id (Text): Unique identifier of the change request to modify (from [change_request] Response_Content (Text): A JSON value containing response information related to the PATCH /sn_chg_rest/change/normal/[sys_id]?[name-value Template Content-Type:application/json None
specified sys_id with the parameters in the request body table). request. pairs] [body]
or the URL. body (Text): Optional parameters. For more details, please refer to the official HTTP Status Code (Text): HTTP Status code returned in response.
documentation. Response Headers (Collection): Collection of headers data returned in response.
name-value pairs (Text): Name-value pairs for the fields to update. Request body
parameters override URL parameters. However, required parameters must be specified in
the URL.
Delete Normal Change Request Deletes the normal change request identified by the *sys_id (Text): Unique identifier of the normal change request to delete [from Response_Content (Text): A JSON value containing response information related to the DELETE /sn_chg_rest/change/normal/[sys_id] None Accept:application/json None
Create Emergency Change Request Creates one emergency change request based on the *key value pairs (Text): Fields to modify when creating the request. The key is the field Response_Content (Text): A JSON value containing response information related to the POST /sn_chg_rest/change/emergency?[key value pairs] None Accept:application/json None
default emergency change request record. Multiple name within the template and the value is the information to populate in the field. request.
emergency change request creations within a single call *ServiceNow Instance (Text): The name of the ServiceNow instance being used. HTTP Status Code (Text): HTTP Status code returned in response.
is not supported. Response Headers (Collection): Collection of headers data returned in response.
Retrieve Emergency Change Request Retrieves one or more emergency change requests order (Text): Field by which to sort the returned change requests. Default: number Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/emergency?order=[order]&syspar None Accept:application/json None
based on the specified criteria. sysparm_limit (Text): Maximum number of records to return. Unusually large request. m_limit=[sysparm_limit]&sysparm_offset=[sysparm_off
sysparm_limit values can impact system performance. For requests that exceed this HTTP Status Code (Text): HTTP Status code returned in response. set]&sysparm_query=[sysparm_query]&[key value
Default: 500
sysparm_query.
textSearch (Text): String to use to search all emergency change request record fields.
This search uses ServiceNow full text search platform functionality and defaults to
IR_AND_OR_QUERY.
Retrieve Emergency Change Request By Retrieves the emergency change request identified by *sys_id (Text): Unique identifier of the emergency change request to retrieve from the Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/emergency/[sys_id] None Accept:application/json None
SysId the specified sys_id. [change_request] table. request.
Update Emergency Change Request By Updates the emergency change request identified by *sys_id (Text): Unique identifier of the change request to modify (from [change_request] Response_Content (Text): A JSON value containing response information related to the PATCH /sn_chg_rest/change/emergency/[sys_id]?[key value Template Content-Type:application/json None
SysId the specified sys_id with the key-value pairs in the table). request. pairs] [body]
request body or the URL. body (Text): Optional parameters. For more details, please refer to the official HTTP Status Code (Text): HTTP Status code returned in response.
documentation. Response Headers (Collection): Collection of headers data returned in response.
key value pairs (Text): Name-value pairs for the fields to update. Request body
the URL.
Delete Emergency Change Request Deletes the emergency change request identified by the *sys_id (Text): Unique identifier of the emergency change request to delete [from Response_Content (Text): A JSON value containing response information related to the DELETE /sn_chg_rest/change/emergency/[sys_id] None Accept:application/json None
Create Default Change Request Task Creates one change request task based on the default *change_sys_id (Text): Unique identifier of the change request to which to associate this Response_Content (Text): A JSON value containing response information related to the POST /sn_chg_rest/change/[change_sys_id]/task?[key value None Accept:application/json None
change request task record and associates it with the task (from [change_request] table). request. pairs]
specified change request. Multiple change request task key value pairs (Text): Fields to modify when creating the request. The key is the field HTTP Status Code (Text): HTTP Status code returned in response.
creations within a single call is not supported. name within the template and the value is the information to populate in the field. Response Headers (Collection): Collection of headers data returned in response.
Retrieve Default Change Request Task By Retrieves one or more tasks associated with a specified *change_sys_id (Text): Unique identifier of the change request whose tasks are to be Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/[change_sys_id]/task?order=[orde None Accept:application/json None
SysId change request based on the specified criteria. retrieved [from change_request table]. request. r]&sysparm_limit=[sysparm_limit]&sysparm_offset=[sy
Note: As of the date of 08/2023, please be advised that order (Text): Field by which to sort the returned change requests. Default: number. HTTP Status Code (Text): HTTP Status code returned in response. sparm_offset]&sysparm_query=[sysparm_query]&[key
the following parameters may not operate as intended: sysparm_limit (Text): Maximum number of records to return. Unusually large Response Headers (Collection): Collection of headers data returned in response. value pairs]&textSearch=[textSearch]
sysparm_query, key value pairs, textSearch. sysparm_limit values can impact system performance.
sysparm_offset (Text): Starting record index for which to begin retrieving records.
sysparm_query (Text): Encoded query used to filter the result set. key value pairs
(Text): Name-value pairs to use to filter the result set.
textSearch (Text): String to use to search all change task record fields.
2 / 14 ページ
POST - Create
PUT,PATCH - Update
DELETE - Delete

Retrieve Change Request Task By SysId And Retrieves the emergency change request identified by *change_sys_id (Text): Unique identifier of the change request whose tasks are to be Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/[change_sys_id]/task/[task_sys_id None Accept:application/json None
TaskId the specified sys_id. retrieved [from change_request table]. request. ]
*task_sys_id (Text): Unique identifier of the task to retrieve (from [change_task] table). HTTP Status Code (Text): HTTP Status code returned in response.
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. Response Headers (Collection): Collection of headers data returned in response.
Update Change Request Task By TaskId And Updates the change request task identified by the *change_sys_id (Text): Unique identifier of the change request whose tasks are to be Response_Content (Text): A JSON value containing response information related to the PATCH /sn_chg_rest/change/[change_sys_id]/task/[task_sys_id Template Content-Type:application/json None
SysId specified sys_ids with the key-value pairs in the retrieved [from change_request table]. request. ]?[key value pairs] [body]
request body or the URL. *task_sys_id (Text): Unique identifier of the task to retrieve (from [change_task] table). HTTP Status Code (Text): HTTP Status code returned in response.
body (Text): Optional parameters. For more details, please refer to the official Response Headers (Collection): Collection of headers data returned in response.
documentation.
key value pairs (Text): Name-value pairs for the fields to update. Request body
the URL.
Delete Change Request Task By TaskId And Deletes the change request task identified by the *change_sys_id (Text): Unique identifier of the change request whose tasks are to be Response_Content (Text): A JSON value containing response information related to the DELETE /sn_chg_rest/change/[change_sys_id]/task/[task_sys_id None Accept:application/json None
SysId specified sys_ids. retrieved [from change_request table]. request. ]
*task_sys_id (Text): Unique identifier of the task to retrieve (from [change_task] table). HTTP Status Code (Text): HTTP Status code returned in response.
Create Change Request Conflict Check By Starts a change request conflict checking process for the *sys_id (Text): Unique identifier of the change management request for which to start Response_Content (Text): A JSON value containing response information related to the POST /sn_chg_rest/change/[sys_id]/conflict None Accept:application/json None
SysId specified change request (sys_id). the conflict checking process (from [change_request] table). request.
Retrieve Change Request Conflict Check By Retrieves the status of the currently running change *sys_id (Text): Unique identifier of the change management request for which to start Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/[sys_id]/conflict None Accept:application/json None
SysId request conflict checking process or the results of the conflict checking process (from [change_request] table). request.
the last completed conflict checking process for the *ServiceNow Instance (Text): The name of the ServiceNow instance being used. HTTP Status Code (Text): HTTP Status code returned in response.
specified change request. Response Headers (Collection): Collection of headers data returned in response.
Delete Change Request Conflict Check By Cancels the running conflict checking process for the *sys_id (Text): Unique identifier of the change request [from change_request table] for Response_Content (Text): A JSON value containing response information related to the DELETE /sn_chg_rest/change/[sys_id]/conflict None Accept:application/json None
SysId specified change request (sys_id). which to cancel the running conflict checking process. request.
Update Change Request Approval By SysId Allows the current user to approve or reject a change *sys_id (Text): Unique identifier of the change request [from change_request table] for Response_Content (Text): A JSON value containing response information related to the PATCH /sn_chg_rest/change/[sys_id]/approvals Template Content-Type:application/json None
request approval record for the specified change which to cancel the running conflict checking process. request. {'state':'[state]','c
request (sys_id). *state (Text): Required approval state. HTTP Status Code (Text): HTTP Status code returned in response. omments':'[comm
comments (テキスト):If the state is rejected, it is required. Reason for the change being Response Headers (Collection): Collection of headers data returned in response. ents]'}
declined.
Retrieve CI By SysId Retrieves multiple CIs associated to a specified change *sys_id (Text): Required. Unique identifier of the change request for which to return the Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/[sys_id]/ci?association_type=[ass None Accept:application/json None
request based on the specified association type. associated CMDB CIs. request. ociation_type]&sysparm_limit=[sysparm_limit]&syspar
Note: As of the date of 08/2023, please be advised that *association_type (Text): Required. Type of association between the CMDB CI and the HTTP Status Code (Text): HTTP Status code returned in response. m_offset=[sysparm_offset]&sysparm_query=[sysparm_
the following parameters may not operate as intended: change request. Response Headers (Collection): Collection of headers data returned in response. query]&[name-value pairs]
sysparm_query, name-value pairs. sysparm_limit (Text): Maximum number of records to return. Unusually large
sysparm_limit values can impact system performance. For requests that exceed this
number of records, use the sysparm_offset parameter to paginate record retrieval.
the field on which the specified value is filtered.
Create CI By SysId Creates the association between a change request and *sys_id (Text): Required. Unique identifier of the change request for which to return the Response_Content (Text): A JSON value containing response information related to the POST /sn_chg_rest/change/[sys_id]/ci Template Content-Type:application/json None
CMDB CIs. The creation of the association is associated CMDB CIs. request. {
done asynchronously, which means that a response is *association_type (Text): Required. Type of association between the CMDB CI and the HTTP Status Code (Text): HTTP Status code returned in response. 'association_type':'
provided immediately and contains details for change request. Response Headers (Collection): Collection of headers data returned in response. [association_type]'
the worker. *cmdb_ci_sys_ids (Text): Required. List of CMDB CI sys_ids to associate to the change ,
request. 'cmdb_ci_sys_ids':
refresh_impacted_services (Text): Flag used when association_type=affected to '[cmdb_ci_sys_ids
populate impacted services based on the list of affected CIs. ]' ,
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. 'refresh_impacted
_services':'[refres
h_impacted_servic
es]'
}
Retrieve Worker Information By SysId Retrieves the current status, information, and errors for *sys_id (Text): Sys_id of the change management asynchronous worker. Located in the Response_Content (Text): A JSON value containing response information related to the GET /sn_chg_rest/change/worker/[sys_id] None Accept:application/json None
the specified asynchronous worker. Change Management Worker [chg_mgt_worker] table. request.
Refresh Impacted Services By SysId Populates the impacted services/CIs related list based *sys_id (Text): Sys_id of the change request to use to refresh the impacted services. Response_Content (Text): A JSON value containing response information related to the POST /sn_chg_rest/change/[sys_id]/refresh_impacted_service None Accept:application/json None
on the primary CI. *ServiceNow Instance (Text): The name of the ServiceNow instance being used. request. s
HTTP Status Code (Text): HTTP Status code returned in response.
3 / 14 ページ
Last Updated: 2023-09-28
■ServiceNow Customer Service Management API
GET - Retrieve
Each action is created using the Account API,Case API,Consumer API,Contact API of the ServiceNow REST API. For more details, please refer to the official ServiceNow documentation.
(Note: The link below is applicable to release version "Tokyo." Please refer to the appropriate version of the documentation depending on your environment.) POST - Create
Account API(/now/account) https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/account-api.html PUT - Update
Case API(/sn_customerservice/case) https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/case-api.html DELETE - Delete
Consumer API(/now/consumer) https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/consumer-api.html
Contact API(/now/contact) https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/contact-api.html

Create CSM Case Creates a new CSM case. body (Text): optional parameters. For more details, please refer to the official Response_Content (Text): A JSON value containing response information related to the POST /sn_customerservice/case Template Content-Type:application/json None
documentation. request. [body]
Create CSM Consumer Creates a new CSM consumer. body (Text): optional parameters. For more details, please refer to the official Response_Content (Text): A JSON value containing response information related to the POST /now/consumer Template Content-Type:application/json None
Create CSM Contact Creates a new CSM contact. body (Text): optional parameters. For more details, please refer to the official Response_Content (Text): A JSON value containing response information related to the POST /now/contact Template Content-Type:application/json None
Retrieve CSM Account Retrieves the specified CSM account. *id (Text): Unique identifier (sys_id) of the account to retrieve; located in the Customer Response_Content (Text): A JSON value containing response information related to the GET /now/account/[id] None Accept:application/json None
[customer_account] table. request.
Retrieve CSM Case Retrieves the specified CSM case. *id (Text): Sys_id of the case to retrieve; located in the Case [sn_customerservice_case] Response_Content (Text): A JSON value containing response information related to the GET /sn_customerservice/case/[id] None Accept:application/json None
table. request.
Retrieve CSM Consumer Retrieves the specified CSM consumer record. *id (Text): Unique identifier of the consumer record to return; located in the Consumer Response_Content (Text): A JSON value containing response information related to the GET /now/consumer/[id] None Accept:application/json None
[csm_consumer] table. request.
Retrieve CSM Contact Retrieves the specified CSM contact. *id (Text): Unique identifier (sys_id) of the contact to retrieve; located in the Contact Response_Content (Text): A JSON value containing response information related to the GET /now/contact/[id] None Accept:application/json None
[customer_contact] table. request.
Retrieve Set of CSM Accounts Retrieves a specified set of CSM accounts. sysparm_limit (Text): Maximum number of records to return. Unusually large Response_Content (Text): A JSON value containing response information related to the GET /now/account?sysparm_limit=[sysparm_limit]&sysparm None Accept:application/json None
sysparm_limit values can impact system performance. For requests that exceed this request. _offset=[sysparm_offset]&sysparm_query=[sysparm_q
number of records, use the sysparm_offset parameter to paginate record retrieval. HTTP Status Code (Text): HTTP Status code returned in response. uery]
Default: 10 Response Headers (Collection): Collection of headers data returned in response.
sysparm_query (Text): Encoded query to use to filter the result set.
Retrieve Set of CSM Cases Retrieves a specified set of CSM cases. sysparm_limit (Text): Maximum number of records to return. Unusually large Response_Content (Text): A JSON value containing response information related to the GET /sn_customerservice/case?sysparm_limit=[sysparm_limi None Accept:application/json None
sysparm_limit values can impact system performance. For requests that exceed this request. t]&sysparm_offset=[sysparm_offset]&sysparm_query=[
number of records, use the sysparm_offset parameter to paginate record retrieval. HTTP Status Code (Text): HTTP Status code returned in response. sysparm_query]
sysparm_offset (Text): Starting record index for which to begin retrieving records. Use Response Headers (Collection): Collection of headers data returned in response.
Retrieve Set of CSM Consumers Retrieves a specified set of CSM consumer records. sysparm_limit (Text): Maximum number of records to return. Unusually large Response_Content (Text): A JSON value containing response information related to the GET /now/consumer?sysparm_limit=[sysparm_limit]&syspar None Accept:application/json None
sysparm_limit values can impact system performance. For requests that exceed this request. m_offset=[sysparm_offset]&sysparm_query=[sysparm_
number of records, use the sysparm_offset parameter to paginate record retrieval. HTTP Status Code (Text): HTTP Status code returned in response. query]
Retrieve Set of CSM Contacts Retrieves a specified set of CSM contacts. sysparm_limit (Text): Maximum number of records to return. Unusually large Response_Content (Text): A JSON value containing response information related to the GET /now/contact?sysparm_limit=[sysparm_limit]&sysparm None Accept:application/json None
sysparm_limit values can impact system performance. For requests that exceed this request. _offset=[sysparm_offset]&sysparm_query=[sysparm_q
number of records, use the sysparm_offset parameter to paginate record retrieval. HTTP Status Code (Text): HTTP Status code returned in response. uery]
Update CSM Case Updates the specified existing CSM case with the body (Text): Optional parameters. For more details, please refer to the official Response_Content (Text): A JSON value containing response information related to the PUT /sn_customerservice/case/[id] Template Content-Type:application/json None
passed-in parameters. documentation. request. [body]
*id (Text): Unique identifier (sys_id) of the case to update; located in the HTTP Status Code (Text): HTTP Status code returned in response.
[sn_customerservice_case] table. Response Headers (Collection): Collection of headers data returned in response.
4 / 14 ページ
■ServiceNow Incident Management API POST - Create
PUT - Update
Each action is created using the Table API of the ServiceNow REST API. For more details, please refer to the official ServiceNow documentation.
(Note: The link below is applicable to release version "Tokyo." Please refer to the appropriate version of the documentation depending on your environment.) DELETE - Delete
https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/c_TableAPI.html

Retrieve Incidents Retrieves multiple incident records. name-value pairs (Text): Name-value pairs to use to filter the result set. This parameter Response_Content (Text): A JSON value containing response information related to the GET /now/table/incident?[name-value None Content-Type:application/json None
is mutually exclusive with sysparm_query. request. pairs]&sysparm_display_value=[sysparm_display_value
sysparm_display_value (Text): Data retrieval operation for reference and choice fields. HTTP Status Code (Text): HTTP Status code returned in response. ]&sysparm_exclude_reference_link=[sysparm_exclude_r
sysparm_exclude_reference_link (Flag): Flag that indicates whether to exclude Table API Response Headers Collection (Collection): Collection of headers data returned in response. eference_link]&sysparm_fields=[sysparm_fields]&syspar
links for reference fields. m_limit=[sysparm_limit]&sysparm_no_count=[sysparm
sysparm_fields (Text): Comma-separated list of field names to return in the response. _no_count]&sysparm_offset=[sysparm_offset]&sysparm
sysparm_limit (Text): Maximum number of records to return. Unusually large _query=[sysparm_query]&sysparm_query_category=[s
sysparm_limit values can impact system performance. For requests that exceed this ysparm_query_category]&sysparm_query_no_domain=
number of records, use the sysparm_offset parameter to paginate record retrieval. [sysparm_query_no_domain]&sysparm_suppress_pagin
sysparm_no_count (Flag): Flag that indicates whether to execute a select count(*) ation_header=[sysparm_suppress_pagination_header]&
query on the table to return the number of rows in the associated table.Default: false sysparm_view=[sysparm_view]
this value to paginate record retrieval.
sysparm_query (Text): Encoded query used to filter the result set.Note: If you want to
retrieve major incidents, set "major_incident_state=accepted" in the sysparm_query.
sysparm_query_category (Text): Name of the category to use for queries.
sysparm_query_no_domain (Flag): Flag that indicates whether to restrict the record
search to only the domains for which the logged in user is configured.
sysparm_suppress_pagination_header (Flag): Flag that indicates whether to remove
the Link header from the response.
sysparm_view (Text): UI view for which to render the data. Determines the fields
returned in the response.
Retrieve Incident By SysId Retrieve a specific incident. *sys_id (Text): Unique identifier of the incidet to retrieve. Response_Content (Text): A JSON value containing response information related to the GET /now/table/incident/[sys_id] None Content-Type:application/json None
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. request.
Response Headers Collection (Collection): Collection of headers data returned in response.
Create Incident Creates a new incident record with the passed-in body (Text): Optional parameters. For more details, please refer to the official Response_Content (Text): A JSON value containing response information related to the POST /now/table/incident Template Content-Type:application/json None
parameters. documentation. Note: To create a major request. [body]
incident, you must pass ','major_incident_state':'accepted' in the body HTTP Status Code (Text): HTTP Status code returned in response.
parameter along with whatever other parameters you require. (However, as of 08/2023, Response Headers Collection (Collection): Collection of headers data returned in response.
this parameter may not function as intended. Exercise caution.)
Update Incident By SysId Updates the specified incident record with the passed-in *sys_id (Text): Unique identifier of the incidet to update. Response_Content (Text): A JSON value containing response information related to the PUT /now/table/incident/[sys_id] Template Content-Type:application/json None
parameters. body (Text): Optional parameters. For more details, please refer to the official request. [body]
documentation. HTTP Status Code (Text): HTTP Status code returned in response.
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. Response Headers Collection (Collection): Collection of headers data returned in response.
Delete Incident By SysId Deletes the specified incident record with the passed-in *sys_id (Text): identifier of the incident to delete. Response_Content (Text): A JSON value containing response information related to the DELETE /now/table/incident/[sys_id] None Content-Type:application/json None
parameters. *ServiceNow Instance (Text): The name of the ServiceNow instance being used. request.
Response Headers Collection (Collection): Collection of headers data returned in response.
5 / 14 ページ
■ServiceNow Service Catalog API POST - Create
PUT - Update
Each action is created using the Service Catalog API of the ServiceNow REST API. For more details, please refer to the official ServiceNow documentation.
https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/c_ServiceCatalogAPI.html

Catalog List Retrieves a list of catalogs to which the user has access *ServiceNow Instance (Text): The name of the ServiceNow instance being used. Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/catalogs None Accept:application/json None
based on the passed in parameters. request.
Single Catalog Info Retrieves the available information for a specified *sys_id (Text): Unique identifier (sys_id) of the catalog to retrieve. Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/catalogs/[sys_id] None Accept:application/json None
catalog. *ServiceNow Instance (Text): The name of the ServiceNow instance being used. request.
Single Catalog Catagories Retrieves the list of available categories for the specified *sys_id (Text): Unique identifier of the catalog whose categories are requested. Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/catalogs/[sys_id] None Accept:application/json None
catalog. *ServiceNow Instance (Text): The name of the ServiceNow instance being used. request.
Single Category Retrieves the available information for a specified *sys_id (Text): Unique identifier of the category for which to return information. Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/categories/[sys_id] None Accept:application/json None
category. *ServiceNow Instance (Text): The name of the ServiceNow instance being used. request.
Items List Retrieves a list of catalog items. *ServiceNow Instance (Text): The name of the ServiceNow instance being used. Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/items None Accept:application/json None
request.
Single Item Retrieves a specified catalog item. *sys_id (Text): Unique identifier (sys_id) of the catalog item to return. Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/items/[sys_id] None Accept:application/json None
Add Item to Cart Adds the specified item to the cart of the current user. *sys_id (Text): Unique sys_id of the item to add to the current cart. Response_Content (Text): A JSON value containing response information related to the POST /sn_sc/servicecatalog/items/[sys_id]/add_to_cart Template Content-Type:application/json None
*quantity (Text): Required. Number of the item to add to the cart. Cannot be a negative request. { 'sysparm_quantity' :
number. HTTP Status Code (Text): HTTP Status code returned in response. '[quantity]',
variable (Text): Name/value pairs of all mandatory cart item variables. Mandatory Response Headers (Collection): Collection of headers data returned in response. 'variables' : {
variables are defined on the associated form. [variable]
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. }
}
Submit Producer Creates a record and returns the Table API relative path *sys_id (Text): Unique sys_id of the item to add to the current cart. Response_Content (Text): A JSON value containing response information related to the POST /sn_sc/servicecatalog/items/[sys_id]/submit_producer Template Content-Type:application/json None
and redirect URL to access the created record. variable (Text): Name/value pairs of the variables of the producer record to request. {'variables':{[variable]}}
define. HTTP Status Code (Text): HTTP Status code returned in response.
Submit Guide Retrieves a list of items based on the needs described *sys_id (Text): Unique identifier of the order guide whose items are to be retrieved Response_Content (Text): A JSON value containing response information related to the PUT /sn_sc/servicecatalog/items/[sys_id]/submit_guide Template Content-Type:application/json None
for an order guide. [from sc_cat_item_guide table]. request. {'variables':{[variable]}}
variable (Text): Array of variables requested for an item. Each variable is a JSON HTTP Status Code (Text): HTTP Status code returned in response.
object consisting of name/value pairs. Response Headers (Collection): Collection of headers data returned in response.
Checkout Guide Retrieves an array of contents requested for checkout. *sys_id (Text): Unique identifier (sys_id) of the checkout guide. Response_Content (Text): A JSON value containing response information related to the POST /sn_sc/servicecatalog/items/[sys_id]/checkout_guide Template Content-Type:application/json None
items (Text): Array of variables requested for an item. Each item is a JSON object request. [items]
with the following parameters: HTTP Status Code (Text): HTTP Status code returned in response.
・sys_id: Required. Unique identifier of the catalog item. Response Headers (Collection): Collection of headers data returned in response.
・variables: JSON object of variable name value pairs.
・sysparm_quantity: number of items. If not specified, the default value is 1.
Order Now Orders the specified catalog item. *sys_id (Text): Unique identifier of the catalog item. Response_Content (Text): A JSON value containing response information related to the POST /sn_sc/servicecatalog/items/[sys_id]/order_now Template Content-Type:application/json None
variable (Text): JSON object containing the variable name and the value. If there are request. { 'sysparm_quantity' :
mandatory variables defined for the item, they must be passed to the HTTP Status Code (Text): HTTP Status code returned in response. '[quantity]',
endpoint. Response Headers (Collection): Collection of headers data returned in response. 'variables' : {
*quantity (Text): Required. Quantity of the item to order. [variable]
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. }
}
Get Cart Details Retrieves the details of the items within the logged in *ServiceNow Instance (Text): The name of the ServiceNow instance being used. Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/cart None None None
user's cart. request.
Get Shipping Address Retrieves the shipping address of the specified user. *user_id (Text): Unique sys_id of the user whose shipping address is to be Response_Content (Text): A JSON value containing response information related to the GET /sn_sc/servicecatalog/cart/delivery_address/[user_id] None None None
retrieved. request.
Cart Update Updates the specified item in the logged in user's cart. *cart_item_id (Text): Unique identifier of the cart item to update. Response_Content (Text): A JSON value containing response information related to the PUT /sn_sc/servicecatalog/cart/[cart_item_id] Template Content-Type:application/json None
variable (Text):Required if there are mandatory variables specified for the item. request. { 'sysparm_quantity' :
Object consisting of all mandatory variable names/value pairs. HTTP Status Code (Text): HTTP Status code returned in response. '[quantity]',
*quantity (Text): Required. Quantity of the item to update the cart. Response Headers (Collection): Collection of headers data returned in response. 'variables' : {
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. [variable]
}
}
Display Value Returns the display value of the specified variable. *sys_id (Text): Unique identifier of the variable for which to return the display value. Response_Content (Text): A JSON value containing response information related to the POST /sn_sc/servicecatalog/variables/[sys_id]/display_value Template Content-Type:application/json None
*sysparm_value (Text): Sys_id of the record that contains the display value to return. request. {"sysparm_value":"[syspar
*ServiceNow Instance (Text): The name of the ServiceNow instance being used. HTTP Status Code (Text): HTTP Status code returned in response. m_value]"}
6 / 14 ページ
■ServiceNow Service Catalog API POST - Create
PUT - Update
Each action is created using the Service Catalog API of the ServiceNow REST API. For more details, please refer to the official ServiceNow documentation.
https://docs.servicenow.com/bundle/tokyo-api-reference/page/integrate/inbound-rest/concept/c_ServiceCatalogAPI.html

Delete Cart Item Deletes the specified item from the current cart. *cart_item_id (Text): Unique identifier of the item to delete from the current cart. Response_Content (Text): A JSON value containing response information related to the DELETE /sn_sc/servicecatalog/cart/[cart_item_id] None Content-Type:application/json None
Delete Cart Deletes a specified cart, and the contents of the cart. *sys_id (Text): Unique identifier (sys_id) of the cart to empty and delete. Response_Content (Text): A JSON value containing response information related to the DELETE /sn_sc/servicecatalog/cart/[sys_id]/empty None Content-Type:application/json None
The capabilities of what a user can delete (items *ServiceNow Instance (Text): The name of the ServiceNow instance being used. request.
and/or cart) depends on the role in which they use to HTTP Status Code (Text): HTTP Status code returned in response.
authenticate. Response Headers (Collection): Collection of headers data returned in response.
Checkout Retrieves and processes the checkout for the current *ServiceNow Instance (Text): The name of the ServiceNow instance being used. Response_Content (Text): A JSON value containing response information related to the POST /sn_sc/servicecatalog/cart/checkout None Content-Type:application/json None
cart based on whether the two-step checkout request.
process is enabled. If one-step checkout, the method HTTP Status Code (Text): HTTP Status code returned in response.
checks out (saves) the cart and returns the Response Headers (Collection): Collection of headers data returned in response.
request number and the request order ID. If two-step
checkout, the method returns the cart order
status and all the information required for two-step
checkout.
Submit Order Checks out the user cart, based on the current check- *ServiceNow Instance (Text): The name of the ServiceNow instance being used. Response_Content (Text): A JSON value containing response information related to the POST /sn_sc/servicecatalog/cart/submit_order None Content-Type:application/json None
out type (one-step or two-step ). request.
7 / 14 ページ
Blue Prism Connectors for ServiceNow - Component List (Japanese) v1.0
GET 取得最終更新日:2023/9/28
■ServiceNow Change Management API POST 作成
PUT,PATCH 更新
各アクションは、ServiceNow REST API の Change Management API を使用して作成されています。詳細については、ServiceNow公式ドキュメントをご参照ください。
(※以下のリンクはリリースバージョン「Tokyo」に対応しています。環境に応じて適切なバージョンのドキュメントをご確認ください。) DELETE 削除
https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/change-management-api.html
アクション説明入力パラメータ出力パラメータ Web API 設定

(*は必須パラメータ) メソッド URLパス本文のコンテンツヘッダー応答
Create Standard Change Request By TemplateId テンプレートIDによる標準変更リクエストの作成。 *standard_change_template_id (テキスト): 新しい標準変更リクエストに基づく標準変 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_chg_rest/change/standard/[standard_change_templ なし Accept:application/json 設定なし
指定されたテンプレートsys_idに指定された既存の標準変更テンプレートに基づいて、更テンプレートの一意の識別子([std_change_record_producer]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード ate_id]?[name-value pairs]
一つの標準変更リクエストを作成します。一回の呼び出しで複数の標準変更リクエスト *name-value pairs (テキスト): リクエストを作成する際に指定の標準変更テンプレート内の Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
を作成することはサポートされていません。フィールドを変更します。キーはテンプレート内のフィールド名で、値はフィールドに入力する情報です。
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL
Retrieve Standard Change Request 指定した条件に基づいて1つまたは複数の標準変更リクエストを取得します。 *order (テキスト): 返される変更リクエストを並べ替えるフィールド。デフォルトはnumber Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/standard?order=[order]&sysparm なし Accept:application/json 設定なし
sysparm_limit (テキスト): 返すレコードの最大数。通常より大きなsysparm_limit値はシス HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード _limit=[sysparm_limit]&sysparm_offset=[sysparm_offse
テムのパフォーマンスに影響を及ぼす可能性があります。このレコード数を超えるリクエストについては、 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション t]&sysparm_query=[sysparm_query]&[name-value
sysparm_offsetパラメータを使用してレコードの取得をページネーションします。 pairs]&textSearch=[textSearch]
sysparm_offset (テキスト): レコードの取得を開始する開始レコードインデックス。この値を使用
してレコードの取得をページネーションします。この機能により、レコードの数に関係なく、すべてのレコー
ドを小さな管理可能なチャンクで取得できます。
sysparm_query (テキスト): 結果セットをフィルタリングするためのエンコードされたクエリ
name-value pairs (テキスト): 結果セットをフィルタリングするために使用する名前-値のペア。
名前は指定された値がフィルタリングされるフィールドです。このパラメータはsysparm_queryとは排
他的です。
textSearch (テキスト): 全ての標準変更リクエストレコードフィールドを検索するために使用する文
字列。この検索はServiceNowの全文検索プラットフォーム機能を使用し、デフォルトでは
IR_AND_OR_QUERYとなります。
Retrieve Standard Change Request By SysId 指定したsys_idによって識別される標準変更リクエストを取得します。 *sys_id (テキスト): 変更要求 [change_request] テーブルから取得する標準的な変更要求 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/standard/[sys_id] なし Accept:application/json 設定なし
の sys_id。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
Update Standard Change Request By SysId リクエスト本文またはURLのパラメータを使用して、指定されたsys_idによって識別され *sys_id (テキスト): 変更する変更要求の sys_id。[change_request] テーブルにあります。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PATCH /sn_chg_rest/change/standard/[sys_id]?[name-value テンプレート Content-Type:application/json 設定なし
る標準変更リクエストを更新します。 name-value pairs (テキスト): 更新するフィールドの名前-値のペア。リクエスト本文のパラメータ HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード pairs] [body]
はURLのパラメータを上書きします。ただし、必須パラメータはURLで指定しなければなりません。 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。
Calculate Change Impact Risk リスク条件の評価に基づいて、指定された標準変更のリスクと影響を計算します。 *sys_id (テキスト): 評価する標準的な変更の sys_id。変更要求 [change_request] テー Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PATCH /sn_chg_rest/change/[sys_id]/risk なし Accept:application/json 設定なし
Change Risk Assessmentプラグインがインストールされている場合、リスク評価がブルにあります。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
完了すると、累積最高リスクも計算します。 *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
Delete Standard Change Request 指定されたsys_idによって識別される標準変更リクエストを削除します。 *sys_id (テキスト):削除する標準的な変更要求の sys_id。変更要求 [change_request] Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 DELETE /sn_chg_rest/change/standard/[sys_id] なし Accept:application/json 設定なし
テーブルにあります。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Retrieve Standard Change Template 指定した基準に基づいて一つ以上の標準変更テンプレートを取得します。 order (テキスト): 返される標準変更テンプレートを並べ替えるフィールド。デフォルトはnumberで Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/standard/template?order=[order]& なし Accept:application/json 設定なし
す。※テンプレートに「number」フィールドは存在しないため、もし「order」が空白のままだと、取得件 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード sysparm_limit=[sysparm_limit]&sysparm_offset=[syspa
数が0となる場合があります。このような場合、"order"に「false」を設定することで、正常に情報を取 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション rm_offset]&sysparm_query=[sysparm_query]&[name-
得することができます。 value pairs]&textSearch=[textSearch]
sysparm_limit (テキスト): 返すレコードの最大数。通常より大きなsysparm_limit値はシス
テムのパフォーマンスに影響を及ぼす可能性があります。このレコード数を超えるリクエストについては、
sysparm_offsetパラメータを使用してレコードの取得をページネーションしてください。デフォルトは
500です。
sysparm_offset (テキスト): レコードの取得を開始するための開始レコードインデックス。この値
を使用してレコードの取得をページネーションします。この機能により、レコードの数に関係なく、小さな
管理可能なチャンクですべてのレコードを取得することができます。
sysparm_query (テキスト): 結果セットをフィルタリングするためのエンコードされたクエリ
name-value pairs (テキスト): 結果セットをフィルタリングするために使用する名前-値のペア。
名前は指定された値がフィルタリングされるフィールドです。このパラメータはsysparm_queryとは排
他的です。
textSearch (テキスト): 全ての標準変更リクエストレコードフィールドを検索するために使用する文
字列。この検索はServiceNowの全文検索プラットフォーム機能を使用し、デフォルトでは
IR_AND_OR_QUERYとなります。
Retrieve Standard Change Template By SysId 指定されたsys_idによって識別される標準変更テンプレートを取得します。 *sys_id (テキスト): [std_change_record_producer] テーブルから取得する標準的な変更 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/standard/template/[sys_id] なし Accept:application/json 設定なし
テンプレートの sys_id。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Create Normal Change Request デフォルトの通常変更リクエストレコードに基づいて、一つの通常変更リクエストを作成 *key value pairs (テキスト): 要求の作成時に変更するフィールド。キーはテンプレート内の Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_chg_rest/change/normal?[key value pairs] なし Accept:application/json 設定なし
します。一回の呼び出しで複数の通常変更リクエストを作成することはサポートされていフィールド名で、値はフィールドに入力する情報です。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
ません。 *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
Retrieve Normal Change Request 指定された基準に基づいて一つまたは複数の通常の変更リクエストを取得します。 order (テキスト): 返された変更要求をソートするためのフィールド。デフォルトはnumber Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/normal?order=[order]&sysparm_li なし Accept:application/json 設定なし
sysparm_limit (テキスト): 返すレコードの最大数。通常以上に大きなsysparm_limit値はシ HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード mit=[sysparm_limit]&sysparm_offset=[sysparm_offset]
ステムパフォーマンスに影響を与える可能性があります。この数のレコードを超えるリクエストの場合は、 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション &sysparm_query=[sysparm_query]&[name-value
sysparm_offsetパラメータを使用してレコードの取得をページネーションします。デフォルトは500 pairs]&textSearch=[textSearch]
sysparm_offset (テキスト): レコードの取得を開始するための開始レコードインデックス。この値
を使用してレコードの取得をページネーションします。この機能は、レコードの数に関係なくすべてのレ
コードを取得することを可能にします。
sysparm_query (テキスト): 結果セットをフィルタするためのエンコードされたクエリ
name-value pairs (テキスト): 結果セットをフィルタするために使用する名前と値のペア。名前
は指定された値がフィルタされるフィールドで、このパラメータはsysparm_queryと互いに排他的で
す。
textSearch (テキスト): すべての通常の変更要求レコードフィールドを検索するために使用する文
字列。この検索では、ServiceNow の全文検索プラットフォーム機能が使用され、デフォルトで
IR_AND_OR_QUERY に設定されます。
Retrieve Normal Change Request By SysId 指定されたsys_idによって識別される通常の変更リクエストを取得します。 *sys_id (テキスト): 変更要求 [change_request] テーブルから取得する通常の変更要求の Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/normal/[sys_id] なし Accept:application/json 設定なし
sys_id。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
8 / 14 ページ
PUT,PATCH 更新

Update Normal Change Request By SysId 指定されたsys_idによって識別される通常の変更リクエストを、リクエスト本文または *sys_id (テキスト): 変更するリクエストの一意の識別子([change_request]テーブルから) Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PATCH /sn_chg_rest/change/normal/[sys_id]?[name-value テンプレート Content-Type:application/json 設定なし
URLのパラメータで更新します。 body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード pairs] [body]
name-value pairs (テキスト): 更新するフィールドの名前と値のペア。リクエスト本文のパラメー Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
タはURLのパラメータを上書きします。ただし、必須パラメータはURLで指定する必要があります。
Delete Normal Change Request 指定されたsys_idによって識別される通常の変更リクエストを削除します。 *sys_id (テキスト): 削除する通常の変更リクエストの一意の識別子([change_request]テー Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 DELETE /sn_chg_rest/change/normal/[sys_id] なし Accept:application/json 設定なし
ブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Create Emergency Change Request デフォルトの緊急変更リクエストレコードに基づいて、一つの緊急変更リクエストを作成 *key value pairs (テキスト): リクエストを作成する際に変更するフィールド。キーはテンプレート Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_chg_rest/change/emergency?[key value pairs] なし Accept:application/json 設定なし
します。一回の呼び出しで複数の緊急変更リクエストを作成することはサポートされてい内のフィールド名で、値はフィールドに入力する情報です。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
ません。 *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
Retrieve Emergency Change Request 指定した基準に基づいて一つまたは複数の緊急変更リクエストを取得します。 order (テキスト): 返された変更要求をソートするためのフィールド。デフォルト: number Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/emergency?order=[order]&syspar なし Accept:application/json 設定なし
sysparm_limit (テキスト): 返すレコードの最大数。非常に大きなsysparm_limitの値はシス HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード m_limit=[sysparm_limit]&sysparm_offset=[sysparm_off
テムパフォーマンスに影響を及ぼす可能性があります。この数のレコードを超えるリクエストには、 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション set]&sysparm_query=[sysparm_query]&[key value
sysparm_offsetパラメータを使用してレコードの取得をページ化します。デフォルト: 500 pairs]&textSearch=[textSearch]
sysparm_offset (テキスト): レコードを取得するための開始レコードインデックス。この値を使用
してレコードの取得をページ化します。この機能は、レコード数に関係なく、すべてのレコードを小さな管
理可能なチャンクで取得することを可能にします。
sysparm_query (テキスト): 結果セットをフィルタするために使用されるエンコードされたクエリ。
key value pairs (テキスト): 結果セットをフィルタするために使用する名前-値のペア。名前は指
定された値がフィルタされるフィールドで、このパラメータはsysparm_queryとは相互排他的です。
textSearch (テキスト): すべての緊急の変更要求レコードフィールドを検索するために使用する文
字列。この検索では、ServiceNow の全文検索プラットフォーム機能が使用され、デフォルトで
IR_AND_OR_QUERY に設定されます。
Retrieve Emergency Change Request By SysId 指定されたsys_idにより識別される緊急変更リクエストを取得します。 *sys_id (テキスト): [change_request]テーブルから取得する緊急変更リクエストの一意識別 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/emergency/[sys_id] なし Accept:application/json 設定なし
子 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Update Emergency Change Request By SysId 指定されたsys_idで識別される緊急変更リクエストをリクエストボディまたはURLのキー *sys_id (テキスト): 変更する変更要求の sys_id。[change_request] テーブルにあります。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PATCH /sn_chg_rest/change/emergency/[sys_id]?[key value テンプレート Content-Type:application/json 設定なし
値ペアで更新します。 body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード pairs] [body]
key value pairs (テキスト): 更新するフィールドの名前-値ペア。リクエストボディのパラメータは Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
URLのパラメータを上書きします。ただし、必要なパラメータはURLで指定する必要があります。
Delete Emergency Change Request 指定されたsys_idで識別される緊急変更リクエストを削除します。 *sys_id (テキスト): 削除する緊急変更リクエストの一意の識別子[change_requestテーブル Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 DELETE /sn_chg_rest/change/emergency/[sys_id] なし Accept:application/json 設定なし
から] HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Create Default Change Request Task デフォルトの変更リクエストタスクレコードに基づいて一つの変更リクエストタスクを作成 *change_sys_id (テキスト): このタスクを関連付ける変更リクエストの一意の識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_chg_rest/change/[change_sys_id]/task?[key value なし Accept:application/json 設定なし
し、指定された変更リクエストに関連付けます。一回の呼び出しで複数の変更リクエス ([change_request]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード pairs]
トタスクを作成することはサポートされていません。 key value pairs (テキスト): リクエストを作成する際に変更するフィールド。キーはテンプレート内 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
のフィールド名で、値はフィールドに入力する情報です。
Retrieve Default Change Request Task By SysId 指定された基準に基づいて特定の変更要求に関連付けられた1つ以上のタスクを取得 *change_sys_id (テキスト): 取得するタスクの変更要求の一意識別子 [change_request Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/[change_sys_id]/task?order=[orde なし Accept:application/json 設定なし
します。 table] HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード r]&sysparm_limit=[sysparm_limit]&sysparm_offset=[sy
※2023年8月時点で、以下のパラメータは、意図通りに動作しない可能性があります order (テキスト): 返される変更要求をソートするためのフィールド。デフォルト:番号 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション sparm_offset]&sysparm_query=[sysparm_query]&[key
のでご注意ください。sysparm_query,key value pairs,textSearch sysparm_limit (テキスト): 戻すレコードの最大数 value pairs]&textSearch=[textSearch]
sysparm_offset (テキスト): レコード取得を開始するための開始レコードインデックス
key value pairs (テキスト): 結果セットをフィルタするための名前-値ペア
textSearch (テキスト): 全ての変更タスクレコードフィールドを検索するための文字列
Retrieve Change Request Task By SysId And TaskId 指定されたsys_idにより識別される緊急変更リクエストを取得します。 *change_sys_id (テキスト): タスクを取得する変更リクエストの一意識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/[change_sys_id]/task/[task_sys_id なし Accept:application/json 設定なし
([change_request]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード ]
*task_sys_id (テキスト): 取得するタスクの一意識別子([change_task]テーブルから) Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
Update Change Request Task By TaskId And SysId リクエストボディまたはURLのkey value pairsで、指定されたsys_idにより識別され *change_sys_id (テキスト): タスクを取得する変更リクエストの一意識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PATCH /sn_chg_rest/change/[change_sys_id]/task/[task_sys_id テンプレート Content-Type:application/json 設定なし
る変更リクエストタスクを更新します。 ([change_request]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード ]?[key value pairs] [body]
body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。
key value pairs (テキスト): 更新するフィールドの名前と値のペア。リクエストボディのパラメータは
URLのパラメータを上書きします。ただし、必要なパラメータはURLで指定する必要があります。
Delete Change Request Task By TaskId And SysId 指定されたsys_idにより識別される変更リクエストタスクを削除します。 *change_sys_id (テキスト): タスクを取得する変更リクエストの一意識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 DELETE /sn_chg_rest/change/[change_sys_id]/task/[task_sys_id なし Accept:application/json 設定なし
([change_request]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード ]
Create Change Request Conflict Check By SysId 指定された変更リクエスト(sys_id)のための変更リクエストの競合チェックプロセスを開 *sys_id (テキスト): 競合チェックプロセスを開始する変更管理リクエストの一意識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_chg_rest/change/[sys_id]/conflict なし Accept:application/json 設定なし
始します。 ([change_request]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Retrieve Change Request Conflict Check By SysId 現在実行中の変更リクエスト競合チェックプロセスのステータス、または指定された変更 *sys_id (テキスト): 競合チェックプロセスを開始する変更管理リクエストの一意識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/[sys_id]/conflict なし Accept:application/json 設定なし
リクエストの最後に完了した競合チェックプロセスの結果を取得します。 ([change_request]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
9 / 14 ページ
PUT,PATCH 更新

Delete Change Request Conflict Check By SysId 指定された変更リクエスト(sys_id)の実行中の競合チェックプロセスをキャンセルしま *sys_id (テキスト): 実行中の競合チェックプロセスをキャンセルするための変更リクエストの一意識 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 DELETE /sn_chg_rest/change/[sys_id]/conflict なし Accept:application/json 設定なし
す。別子([change_request]テーブルから) HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Update Change Request Approval By SysId 現在のユーザーが、指定された変更リクエスト(sys_id)の変更リクエスト承認レコードを *sys_id (テキスト): 承認/却下が適用される変更要求の sys_id。変更要求 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PATCH /sn_chg_rest/change/[sys_id]/approvals テンプレート Content-Type:application/json 設定なし
承認または拒否することを許可します。 [change_request] テーブルにあります。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード {'state':'[state]','com
*state (テキスト): 必要な承認状態 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション ments':'[comments]'}
comments (テキスト):state が rejected の場合は必須です。変更が却下された理由。
Retrieve CI By SysId 指定された関連付けタイプに基づいて、特定の変更リクエストに関連付けられた複数の *sys_id (テキスト): 必須。関連するCMDB CIsを返す変更リクエストの一意識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/[sys_id]/ci?association_type=[ass なし Accept:application/json 設定なし
CIを取得します。 *association_type (テキスト): 必須。CMDB CIと変更リクエストとの関連のタイプ HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード ociation_type]&sysparm_limit=[sysparm_limit]&syspar
※2023年8月時点で、以下のパラメータは、意図通りに動作しない可能性があります sysparm_limit (テキスト): 返すレコードの最大数。通常以上に大きなsysparm_limitの値は Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション m_offset=[sysparm_offset]&sysparm_query=[sysparm_
のでご注意ください。sysparm_query,name-value pairs システムのパフォーマンスに影響を与える可能性があります。このレコード数を超えるリクエストについて query]&[name-value pairs]
は、レコードの取得をページネーションするためにsysparm_offsetパラメータを使用してください。
sysparm_offset (テキスト): レコード取得を開始する開始レコードインデックス。この値を使って
レコードの取得をページネーションします。この機能により、レコード数に関係なく、全てのレコードを小さ
な管理可能なチャンクで取得することが可能となります。
name-value pairs (テキスト): 結果セットをフィルタするための名前-値のペア。名前は指定され
た値がフィルタされるフィールドです。
Create CI By SysId 変更リクエストとCMDB CIとの間の関連付けを作成します。関連付けの作成は非同 *sys_id (テキスト): 必須。関連するCMDB CIsを返す変更リクエストの一意識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_chg_rest/change/[sys_id]/ci テンプレート Content-Type:application/json 設定なし
期に行われるため、レスポンスは即時に提供され、ワーカーの詳細を含みます。 *association_type (テキスト): 必須。CMDB CIと変更リクエストとの関連のタイプ HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード {
*cmdb_ci_sys_ids (テキスト): 必須。変更リクエストに関連付けるためのCMDB CI Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション 'association_type':'[as
sys_idsのリスト sociation_type]' ,
refresh_impacted_services (テキスト): association_type=affectedの場合に使用さ 'cmdb_ci_sys_ids':'[c
れるフラグで、影響を受けるCIsのリストに基づいて影響を受けるサービスを取得します。 mdb_ci_sys_ids]' ,
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL 'refresh_impacted_ser
vices':'[refresh_impact
ed_services]'
}
Retrieve Worker Information By SysId 指定された非同期ワーカーの現在のステータス、情報、およびエラーを取得します。 *sys_id (テキスト): 変更管理非同期ワーカーの sys_id。Change Management ワーカー Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_chg_rest/change/worker/[sys_id] なし Accept:application/json 設定なし
[chg_mgt_worker] テーブルにあります。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Refresh Impacted Services By SysId 主要なCIに基づいて影響を受けるサービス/CIの関連リストを生成します。 *sys_id (テキスト): 影響を受けるサービスを更新するために使用する変更要求の sys_id。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_chg_rest/change/[sys_id]/refresh_impacted_service なし Accept:application/json 設定なし
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード s
Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
10 / 14 ページ
最終更新日:2023/9/28
■ServiceNow Customer Service Management API
各アクションは、ServiceNow REST API の Account API,Case API,Consumer API,Contact API を使用して作成されています。詳細については、ServiceNow公式ドキュメントをご参照ください。
GET 取得
(※以下のリンクはリリースバージョン「Tokyo」に対応しています。環境に応じて適切なバージョンのドキュメントをご確認ください。)
Account API(/now/account) https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/account-api.html POST 作成
Case API(/sn_customerservice/case) https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/case-api.html PUT 更新
Consumer API(/now/consumer) https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/consumer-api.html DELETE 削除
Contact API(/now/contact) https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/contact-api.html

Create CSM Case 新しいCSMケースを作成します。 body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_customerservice/case テンプレート Content-Type:application/json 設定なし
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード [body]
Create CSM Consumer 新しいCSM顧客を作成します。 body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /now/consumer テンプレート Content-Type:application/json 設定なし
Create CSM Contact 新しいCSM連絡先を作成します。 body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /now/contact テンプレート Content-Type:application/json 設定なし
Retrieve CSM Account 指定されたCSMアカウントを取得します。 *id (テキスト): 取得するアカウントの一意の識別子（sys_id）; Customer Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /now/account/[id] なし Accept:application/json 設定なし
[customer_account] テーブルに位置します。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Retrieve CSM Case 指定されたCSMケースを取得します。 *id (テキスト): 取得するケースのsys_id; Case [sn_customerservice_case] テーブルに位 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_customerservice/case/[id] なし Accept:application/json 設定なし
置します。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Retrieve CSM Consumer 指定されたCSM顧客レコードを取得します。 *id (テキスト): 取得する顧客レコードの一意の識別子; Consumer [csm_consumer] テーブ Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /now/consumer/[id] なし Accept:application/json 設定なし
ルに位置します。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Retrieve CSM Contact 指定されたCSM連絡先を取得します。 *id (テキスト): 取得する連絡先の一意の識別子（sys_id）; Contact Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /now/contact/[id] なし Accept:application/json 設定なし
[customer_contact] テーブルに位置します。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Retrieve Set of CSM Accounts 指定されたCSMアカウントのセットを取得します。 sysparm_limit (テキスト): 戻すレコードの最大数。異常に大きなsysparm_limit値はシステ Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /now/account?sysparm_limit=[sysparm_limit]&sysparm なし Accept:application/json 設定なし
ムパフォーマンスに影響を与える可能性があります。この数のレコードを超えるリクエストの場合、 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード _offset=[sysparm_offset]&sysparm_query=[sysparm_q
sysparm_offsetパラメータを使用してレコードの取得をページ分けします。デフォルト:10 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション uery]
してレコードの取得をページ分けします。この機能により、レコードの数に関係なく、全てのレコードを小
さな管理可能なチャンクで取得することができます。
sysparm_query (テキスト): 結果セットをフィルタリングするために使用するエンコードされたクエ
リ。
Retrieve Set of CSM Cases 指定されたCSMケースのセットを取得します。 sysparm_limit (テキスト): 戻すレコードの最大数。異常に大きなsysparm_limit値はシステ Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_customerservice/case?sysparm_limit=[sysparm_limi なし Accept:application/json 設定なし
ムパフォーマンスに影響を与える可能性があります。この数のレコードを超えるリクエストの場合、 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード t]&sysparm_offset=[sysparm_offset]&sysparm_query=[
sysparm_offsetパラメータを使用してレコードの取得をページ分けします。 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション sysparm_query]
リ。
Retrieve Set of CSM Consumers 指定されたCSM顧客レコードのセットを取得します。 sysparm_limit (テキスト): 戻すレコードの最大数。異常に大きなsysparm_limit値はシステ Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /now/consumer?sysparm_limit=[sysparm_limit]&syspar なし Accept:application/json 設定なし
ムパフォーマンスに影響を与える可能性があります。この数のレコードを超えるリクエストの場合、 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード m_offset=[sysparm_offset]&sysparm_query=[sysparm_
sysparm_offsetパラメータを使用してレコードの取得をページ分けします。デフォルト:10 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション query]
リ。
Retrieve Set of CSM Contacts 指定されたCSM連絡先のセットを取得します。 sysparm_limit (テキスト): 戻すレコードの最大数。異常に大きなsysparm_limit値はシステ Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /now/contact?sysparm_limit=[sysparm_limit]&sysparm なし Accept:application/json 設定なし
ムパフォーマンスに影響を与える可能性があります。この数のレコードを超えるリクエストの場合、 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード _offset=[sysparm_offset]&sysparm_query=[sysparm_q
sysparm_offsetパラメータを使用してレコードの取得をページ分けします。デフォルト:10 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション uery]
リ。
Update CSM Case 渡されたパラメータで指定された既存のCSMケースを更新します。 body (テキスト): オプションのパラメータ ※詳細は公式ドキュメントを参照してください。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PUT /sn_customerservice/case/[id] テンプレート Content-Type:application/json 設定なし
*id (テキスト): 更新するケースの一意の識別子（sys_id）; [sn_customerservice_case] HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード [body]
テーブルに位置します。 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
11 / 14 ページ
■ServiceNow Incident Management API POST 作成
各アクションは、ServiceNow REST API の Table API を使用して作成されています。詳細については、ServiceNow公式ドキュメントをご参照ください。 PUT 更新
https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/c_TableAPI.html

Retrieve Incidents 複数のインシデントレコードを取得します。 name-value pairs (テキスト): 結果セットをフィルタするために使用する名前-値のペア。このパ Response_Content (テキスト): リクエストに関連するレスポンス情報を含むJSON値 GET /now/table/incident?[name-value なし Content-Type:application/json 設定なし
ラメータはsysparm_queryと相互に排他的です。 HTTP Status Code (テキスト): レスポンスで返されるHTTPステータスコード pairs]&sysparm_display_value=[sysparm_display_value]
sysparm_display_value (テキスト): 参照フィールドと選択フィールドのデータ取得操作 Response Headers Collection (コレクション): レスポンスで返されるヘッダーデータのコレクション &sysparm_exclude_reference_link=[sysparm_exclude_r
sysparm_exclude_reference_link (フラグ): 参照フィールドのTable APIリンクを除外す eference_link]&sysparm_fields=[sysparm_fields]&syspar
るかどうかを示すフラグ m_limit=[sysparm_limit]&sysparm_no_count=[sysparm
sysparm_fields (テキスト): レスポンスで返すフィールド名のカンマ区切りリスト _no_count]&sysparm_offset=[sysparm_offset]&sysparm
sysparm_limit (テキスト): 返すレコードの最大数。通常以上に大きなsysparm_limit値はシ _query=[sysparm_query]&sysparm_query_category=[s
ステムパフォーマンスに影響を与える可能性があります。この数を超えるレコードのリクエストについては、 ysparm_query_category]&sysparm_query_no_domain=[
レコード取得をページ分けするためにsysparm_offsetパラメータを使用します。 sysparm_query_no_domain]&sysparm_suppress_pagina
sysparm_no_count (フラグ): テーブルに対して select count(*) クエリを実行して、関連 tion_header=[sysparm_suppress_pagination_header]&s
テーブルの行数を返すかどうかを示すフラグ。デフォルト値:false ysparm_view=[sysparm_view]
してレコード取得をページ分けします。
sysparm_query (テキスト): 結果セットをフィルタするために使用されるエンコードされたクエリ ※
重大なインシデントを取得する場合は、sysparm_queryに
「major_incident_state=accepted」を設定します。
sysparm_query_category (テキスト): クエリに使用するカテゴリの名前
sysparm_query_no_domain (フラグ): ログインユーザが設定されているドメインのみにレコー
ド検索を制限するかどうかを示すフラグ
sysparm_suppress_pagination_header (フラグ): レスポンスからLinkヘッダを削除する
かどうかを示すフラグ
sysparm_view (テキスト): データをレンダリングするUIビュー。レスポンスで返されるフィールドを
決定します。
Retrieve Incident By SysId 特定のインシデントを取得します。 *sys_id (テキスト): 取得するインシデントの一意の識別子 Response_Content (テキスト): リクエストに関連するレスポンス情報を含むJSON値 GET /now/table/incident/[sys_id] なし Content-Type:application/json 設定なし
*ServiceNow Instance (テキスト): ServiceNow インスタンスの URL HTTP Status Code (テキスト): レスポンスで返されるHTTPステータスコード
Response Headers Collection (コレクション): レスポンスで返されるヘッダーデータのコレクション
Create Incident 渡されたパラメーターで新しいインシデントレコードを作成します。 body (テキスト): 任意のパラメータ(詳細は公式ドキュメントを参照) ※重大なインシデントを作成 Response_Content (テキスト): リクエストに関連するレスポンス情報を含むJSON値 POST /now/table/incident テンプレート Content-Type:application/json 設定なし
するには、必要な他のパラメータと一緒に、bodyパラメータに HTTP Status Code (テキスト): レスポンスで返されるHTTPステータスコード [body]
'major_incident_state':'accepted'を渡す必要があります。(ただし、2023年8月現在、正常 Response Headers Collection (コレクション): レスポンスで返されるヘッダーデータのコレクション
に動作しない可能性があります。)
*ServiceNow Instance (テキスト): ServiceNow インスタンスの URL
Update Incident By SysId 渡されたパラメーターで指定したインシデントレコードを更新します。 *sys_id (テキスト): 更新するインシデントの一意の識別子 Response_Content (テキスト): リクエストに関連するレスポンス情報を含むJSON値 PUT /now/table/incident/[sys_id] テンプレート Content-Type:application/json 設定なし
body (テキスト): 任意のパラメータ(詳細は公式ドキュメントを参照) HTTP Status Code (テキスト): レスポンスで返されるHTTPステータスコード [body]
*ServiceNow Instance (テキスト): ServiceNow インスタンスの URL Response Headers Collection (コレクション): レスポンスで返されるヘッダーデータのコレクション
Delete Incident By SysId 渡されたパラメーターで指定したインシデントレコードを削除します。 *sys_id (テキスト): 削除するインシデントの一意の識別子 Response_Content (テキスト): リクエストに関連するレスポンス情報を含むJSON値 DELETE /now/table/incident/[sys_id] なし Content-Type:application/json 設定なし
*ServiceNow Instance (テキスト): ServiceNow インスタンスの URL HTTP Status Code (テキスト): レスポンスで返されるHTTPステータスコード
Response Headers Collection (コレクション): レスポンスで返されるヘッダーデータのコレクション
12 / 14 ページ
■ServiceNow Service Catalog API POST 作成
各アクションは、ServiceNow REST API の Service Catalog API を使用して作成されています。詳細については、ServiceNow公式ドキュメントをご参照ください。 PUT 更新
https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/c_ServiceCatalogAPI.html

Catalog List 渡されたパラメータに基づいて、ユーザーがアクセス可能なカタログのリストを取得します。 *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/catalogs なし Accept:application/json 設定なし
HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Single Catalog Info 指定されたカタログの利用可能な情報を取得します。 *sys_id (テキスト): 取得するカタログの一意の識別子（sys_id） Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/catalogs/[sys_id] なし Accept:application/json 設定なし
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
Single Catalog Catagories 指定されたカタログの利用可能なカテゴリのリストを取得します。 *sys_id (テキスト): カテゴリの情報が必要なカタログの一意の識別子。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/catalogs/[sys_id] なし Accept:application/json 設定なし
Single Category 指定されたカテゴリの利用可能な情報を取得します。 *sys_id (テキスト): 情報を取得するカテゴリの一意の識別子。 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/categories/[sys_id] なし Accept:application/json 設定なし
Items List カタログアイテムのリストを取得します。 *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/items なし Accept:application/json 設定なし
Single Item 指定されたカタログアイテムを取得します。 *sys_id (テキスト): 返すカタログアイテムの一意の識別子（sys_id） Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/items/[sys_id] なし Accept:application/json 設定なし
Add Item to Cart 現在のユーザーのカートに指定されたアイテムを追加します。 *sys_id (テキスト): 現在のカートに追加するアイテムの一意のsys_id Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_sc/servicecatalog/items/[sys_id]/add_to_cart テンプレート Content-Type:application/json 設定なし
*quantity (テキスト): 必須。カートに追加するアイテムの数量。負の数は指定できません。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード { 'sysparm_quantity' :
variable (テキスト): 必須のカートアイテム変数の名前と値のペア。必須の変数は関連するフォー Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション '[quantity]',
ムで定義されています。 'variables' : {
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL [variable]
}
}
Submit Producer レコードを作成し、作成されたレコードにアクセスするためのTable APIの相対パスとリダ *sys_id (テキスト): 現在のカートに追加するアイテムの一意のsys_id Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_sc/servicecatalog/items/[sys_id]/submit_producer テンプレート Content-Type:application/json 設定なし
イレクトURLを作成します。 variable (テキスト): 定義するプロデューサーレコードの変数の名前と値のペア HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード {'variables':{[variable]}}
Submit Guide 注文ガイドに記載された要件に基づいて、アイテムのリストを取得します。 *sys_id (テキスト): アイテムを取得する注文ガイドの一意の識別子 [sc_cat_item_guideテー Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PUT /sn_sc/servicecatalog/items/[sys_id]/submit_guide テンプレート Content-Type:application/json 設定なし
ブルから] HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード {'variables':{[variable]}}
variable (テキスト): アイテムに要求された変数の配列。各変数は名前/値のペアで構成された Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
JSONオブジェクトです。
Checkout Guide チェックアウトのために要求されたコンテンツの配列を取得します。 *sys_id (テキスト): チェックアウトガイドの一意の識別子（sys_id） Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_sc/servicecatalog/items/[sys_id]/checkout_guide テンプレート Content-Type:application/json 設定なし
items (テキスト): 項目に要求された変数の配列です。各項目は以下のパラメータを持つJSONオ HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード [items]
ブジェクトです: Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
・sys_id: 必須。カタログ項目の一意な識別子。
・variables: 変数名と値のペアを持つJSONオブジェクト。
・sysparm_quantity: 項目の数。指定されていない場合、デフォルト値は1です。
Order Now 指定されたカタログアイテムを注文します。 *sys_id (テキスト): カタログアイテムの一意の識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_sc/servicecatalog/items/[sys_id]/order_now テンプレート Content-Type:application/json 設定なし
variable (テキスト): 変数名と値を含むJSONオブジェクト。アイテムに必須の変数が定義されてい HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード { 'sysparm_quantity' :
る場合、エンドポイントに渡す必要があります。 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション '[quantity]',
*quantity (テキスト): 必須。注文するアイテムの数量 'variables' : {
}
}
Get Cart Details ログインしているユーザーのカート内のアイテムの詳細を取得します。 *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/cart なしなし設定なし
Get Shipping Address 指定されたユーザーの配送先住所を取得します。 *user_id (テキスト): 配送先住所を取得するユーザーの一意のsys_id Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 GET /sn_sc/servicecatalog/cart/delivery_address/[user_id] なしなし設定なし
Cart Update ログインしているユーザーのカート内の指定されたアイテムを更新します。 *cart_item_id (テキスト): 更新するカートアイテムの一意の識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 PUT /sn_sc/servicecatalog/cart/[cart_item_id] テンプレート Content-Type:application/json 設定なし
variable (テキスト): アイテムに必須の変数が指定されている場合に必要です。すべての必須変 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード { 'sysparm_quantity' :
数の名前と値のペアで構成されたオブジェクトです。 Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション '[quantity]',
*quantity (テキスト): 必須。カート内のアイテムの数量を更新します。 'variables' : {
}
}
Display Value 指定された変数の表示値を返します。 *sys_id (テキスト): 表示値を返す変数の一意の識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_sc/servicecatalog/variables/[sys_id]/display_value テンプレート Content-Type:application/json 設定なし
*sysparm_value (テキスト): 返される表示値を含むレコードの sys_id HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード {"sysparm_value":"[syspar
*ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション m_value]"}
Delete Cart Item 現在のカートから指定されたアイテムを削除します。 *cart_item_id (テキスト): 現在のカートから削除するアイテムの一意の識別子 Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 DELETE /sn_sc/servicecatalog/cart/[cart_item_id] なし Content-Type:application/json 設定なし
Delete Cart 指定されたカートとカート内の内容を削除します。ユーザーが削除できる内容（アイテ *sys_id (テキスト): 空にして削除するカートの一意の識別子（sys_id） Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 DELETE /sn_sc/servicecatalog/cart/[sys_id]/empty なし Content-Type:application/json 設定なし
ムと/またはカート）の機能は、認証に使用する役割によって異なります。 *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
13 / 14 ページ
■ServiceNow Service Catalog API POST 作成
各アクションは、ServiceNow REST API の Service Catalog API を使用して作成されています。詳細については、ServiceNow公式ドキュメントをご参照ください。 PUT 更新
https://docs.servicenow.com/ja-JP/bundle/tokyo-application-development/page/integrate/inbound-rest/concept/c_ServiceCatalogAPI.html

Checkout 現在のカートに対して、2ステップチェックアウトプロセスが有効かどうかに基づいてチェック *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_sc/servicecatalog/cart/checkout なし Content-Type:application/json 設定なし
アウトを取得し処理します。1ステップチェックアウトの場合、メソッドはカートをチェックアウ HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
ト（保存）し、リクエスト番号とリクエスト注文IDを返します。2ステップチェックアウトの Response Headers (コレクション): 応答で返されるヘッダーデータのコレクション
場合、メソッドはカートの注文ステータスと2ステップチェックアウトに必要なすべての情報
を返します。
Submit Order 現在のチェックアウトタイプ（1ステップまたは2ステップ）に基づいて、ユーザーカートを *ServiceNow Instance (テキスト): ServiceNowインスタンスのURL Response_Content (テキスト): リクエストに関連する応答情報を含むJSON値 POST /sn_sc/servicecatalog/cart/submit_order なし Content-Type:application/json 設定なし
チェックアウトします。 HTTP Status Code (テキスト): 応答で返されるHTTPステータスコード
14 / 14 ページ

Component List v1.0 - EN & JP

Uploaded by

Copyright:

Available Formats

You might also like

Component List v1.0 - EN & JP

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Component List v1.0 - EN & JP

Uploaded by

Copyright:

Available Formats

Blue Prism Connectors for ServiceNow - Component List (English) v1.

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

You might also like

Component List v1.0 - EN & JP

Uploaded by

Copyright:

Available Formats

You might also like

Component List v1.0 - EN & JP

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Component List v1.0 - EN & JP

Uploaded by

Copyright:

Available Formats

Blue Prism Connectors for ServiceNow - Component List (English) v1.

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

Actions Description Input Parameter Output Parameter Web API settings

アクション 説明 入力パラメータ 出力パラメータ Web API 設定

アクション 説明 入力パラメータ 出力パラメータ Web API 設定

アクション 説明 入力パラメータ 出力パラメータ Web API 設定

アクション 説明 入力パラメータ 出力パラメータ Web API 設定

アクション 説明 入力パラメータ 出力パラメータ Web API 設定

アクション 説明 入力パラメータ 出力パラメータ Web API 設定

アクション 説明 入力パラメータ 出力パラメータ Web API 設定

You might also like

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定

アクション説明入力パラメータ出力パラメータ Web API 設定