Service Catalog API
-
- UpdatedFeb 1, 2024
- 62 minutes to read
- Washington DC
- API reference
The Service Catalog API provides endpoints that access Service Catalog configuration and actions from within a Service Portal.
Service Catalog - DELETE /sn_sc/servicecatalog/cart/{cart_item_id}
Deletes the specified item from the current cart.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}
Default URL: /api/sn_sc/servicecatalog/cart/{cart_item_id}
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
cart_item_id | Sys_id of the item to delete from the current cart. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
None |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Name | Description |
---|---|
None |
Example: cURL request
Service Catalog - DELETE /sn_sc/servicecatalog/cart/{sys_id}/empty
Deletes a specified cart, and the contents of the cart.
The capabilities of what a user can delete (items and/or cart) depends on the role in which they use to authenticate.
- admin/catalog_admin: Can empty any user cart.
- admin: Can delete the cart after all the contents of the cart are deleted.
- catalog_admin: Can delete all the items in the cart.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/cart/{sys_id}/empty
Default URL: /api/sn_sc/servicecatalog/cart/{sys_id}/empty
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the cart to empty and delete. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
None |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Name | Description |
---|---|
None |
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/cart
Retrieves the details of the items within the logged in user's cart.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/cart
Default URL: /api/sn_sc/servicecatalog/cart
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/cart/delivery_address/{user_id}
Retrieves the shipping address of the specified user based on the glide.sc.req_for.roles property and the default behavior configured in the glide.sc.req_for.roles.defaultproperty.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/cart/delivery_address/{user_id}
Default URL: /api/sn_sc/servicecatalog/cart/delivery_address/{user_id}
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
user_id | Sys_id of the user whose shipping address is to be retrieved. Located in the
User [sys_user] table. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Name | Description |
---|---|
result | Address of the specified user. Data type: String |
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/catalogs
Retrieves a list of catalogs to which the user has access based on the passed in parameters.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/catalogs
Default URL: /api/sn_sc/servicecatalog/catalogs
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
Name | Description |
---|---|
sysparm_limit | Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval.
This limit is applied before ACL evaluation. If no records return, including records you have access to, rearrange the record order so records you have access to return first. Note: Unusually large sysparm_limit values can impact system performance. Data type: Number Default: 10000 |
sysparm_text | Keyword to search for in the "title" field of the available service
catalogs. Data type: String |
sysparm_view | Device on which the item can display:
Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Status code | Description |
---|---|
200 | Indicates that the request completed successfully. If a valid query returns no results, the response body only contains an empty result array. |
401 | Unauthorized. The user credentials are incorrect or have not been passed. |
500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/catalogs/{sys_id}/categories
Retrieves the list of available categories for the specified catalog.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}/categories
Default URL: /api/sn_sc/servicecatalog/catalogs/{sys_id}/categories
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the catalog whose categories are requested. Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/catalogs/{sys_id}
Retrieves the available information for a specified catalog.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}
Default URL: /api/sn_sc/servicecatalog/catalogs/{sys_id}
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the catalog to retrieve. Data type: String |
Name | Description |
---|---|
sysparm_view | Device on which the item can display:
Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/categories/{sys_id}
Retrieves the available information for a specified category.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/categories/{sys_id}
Default URL: /api/sn_sc/servicecatalog/categories/{sys_id}
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the category for which to return information. Data type: String |
Name | Description |
---|---|
sysparm_view | UI view for which to render the data. Determines the fields returned in the response. Valid values:
If you also specify the sysparm_fields parameter, it takes precedent. Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/items
Retrieves a list of catalog items based on the specified parameters.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items
Default URL: /api/sn_sc/servicecatalog/items
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Status code | Description |
---|---|
200 | Returns a list of catalogs and items based on the specified parameters. If a valid query results in no items, then the response body contains only an empty result array. |
401 | Unauthorized. The user credentials are incorrect or have not been passed. |
500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}
Verifies whether the specified delegated user has acquisition rights to the specified service catalog item.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}
Default URL: /api/sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
item_sys_id | Sys_id of the service catalog item to verify
whether the specified user has acquisition rights. Located in the Service Catalog
[sc_catalog] table. Data type: String |
user_sys_id | Sys_id of the user to check whether they have acquisition rights to the
specified service catalog item. Located in the Users [sys_users] table. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Status code | Description |
---|---|
200 | Successful. The request was successfully processed. |
401 | Unauthorized. The user credentials are incorrect or have not been passed. |
500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
Name | Description |
---|---|
result | Flag that indicates whether the specified user has acquisition rights to the
specified service catalog item. Valid values:
|
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/items/{sys_id}
Retrieves a specified catalog item.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}
Default URL: /api/sn_sc/servicecatalog/items/{sys_id}
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the catalog item to return. Data type: String |
Name | Description |
---|---|
sysparm_view | UI view for which to render the data. Determines the fields returned in the response. Valid values:
If you also specify the sysparm_fields parameter, it takes precedent. Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/wishlist
Retrieves the list of items in the logged in user's wish list.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/wishlist
Default URL: /api/sn_sc/servicecatalog/wishlist
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Status code | Description |
---|---|
200 | Successful. The request was successfully processed. |
401 | Unauthorized. The user credentials are incorrect or have not been passed. |
500 | Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error. |
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - GET /sn_sc/servicecatalog/wishlist/{cart_item_id}
Retrieves the details of the specified item stored in the wish list cart.
URL format
Versioned URL: /api/sn_sc/v1/servicecatalog/wishlist/{cart_item_id}
Default URL: /api/sn_sc/servicecatalog/wishlist/{cart_item_id}
Supported request parameters
Name | Description |
---|---|
cart_item_id | Sys_id of the wish list cart item to retrieve. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - POST /sn_sc/servicecatalog/cart/checkout
Retrieves and processes the checkout for the current cart based on whether the two-step checkout process is enabled.
If one-step checkout, the method checks out (saves) the cart and returns the 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.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/cart/checkout
Default URL: /api/sn_sc/servicecatalog/cart/checkout
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - POST /sn_sc/servicecatalog/cart/submit_order
Checks out the user cart, based on the current check-out type (one-step or two-step).
If one-step checkout, the method checks out (saves) the cart and returns the 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.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/cart/submit_order
Default URL: /api/sn_sc/servicecatalog/cart/submit_order
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart
Adds the specified item to the cart of the current user.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_cart
Default URL: /api/sn_sc/servicecatalog/items/{sys_id}/add_to_cart
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the item to add to the current cart. Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
None |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: Sample cURL request and response
Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_wishlist
Adds the specified item to the wish list cart.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_wishlist
Default URL: /api/sn_sc/ servicecatalog/items/{sys_id}/add_to_wishlist
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the item to add to the wish list. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Name | Description |
---|---|
None |
Example: cURL request
Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/checkout_guide
Retrieves an array of contents requested for checkout.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/checkout_guide
Default URL: /api/sn_sc/servicecatalog/items/{sys_id}/checkout_guide
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the checkout guide for which to return the information. Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - POST /sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users
Returns a list of users whose request for the specified item cannot be delegated (requested by another user).
You can call this endpoint prior to calling an endpoint such as Service Catalog API - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart or Service Catalog API - POST /sn_sc/servicecatalog/items/{sys_id}/order_now that allow the requisition of a service catalog item on behalf of another person. These calls fail if you pass in a user that is not authorized for the associated item. This endpoint allows you to verify your list of users prior to calling an endpoint that orders the item or tries to add the item to a cart.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users
Default URL: /api/sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
item_sys_id | Sys_id of the service catalog item to verify
whether the specified user has acquisition rights. Located in the Service Catalog
[sc_catalog] table. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
sysparm_also_request_for | Comma separated string of valid user sys_ids. The endpoint verifies that these
users have acquisition rights to the specified service catalog item. Located in the
Users [sys_user] table. Data type: String |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Name | Description |
---|---|
errCode | Number associated with the error. Only returned if the endpoint fails. Data type: String |
errMsg | Description of the error that the endpoint encountered when it failed. |
invalidUsers | Names of the users that are not able to request the specified catalog
item. Data type: Array |
Example: cURL request
Example: cURL request
Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/order_now
Orders the specified catalog item.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/order_now
Default URL: /api/sn_sc/servicecatalog/items/{sys_id}/order_now
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the service catalog item. Located in the Catalog Item [sc_cat_item] table. Data type: String |
Name | Description |
---|---|
None |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: Sample cURL request
Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/submit_producer
Creates a record and returns the Table API relative path and redirect URL to access the created record.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_producer
Default URL: /api/sn_sc/servicecatalog/items/{sys_id}/submit_producer
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the table in which to create the record producer. Data type: String |
Name | Description |
---|---|
sysparm_view | UI view for which to render the data. Determines the fields returned in the response. Valid values:
If you also specify the sysparm_fields parameter, it takes precedent. Data type: String |
Name | Description |
---|---|
variables | Name-value pairs of the variables of the producer record to define. |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - POST /sn/sc/servicecatalog/variables/{sys_id}/display_value
Returns the display value of the specified variable.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/variables/{sys_id}/display_value
Default URL: /api/sn_sc/servicecatalog/variables/{sys_id}/display_value
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the variable for which to return the display value. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
sysparm_value | Sys_id of the record that contains the display value to return. Data type: String |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Name | Description |
---|---|
result | Display value of the variable. Data type: String |
Example: cURL request
Service Catalog - PUT /sn_sc/servicecatalog/cart/{cart_item_id}
Updates the specified item in the logged in user's cart.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}
Default URL: /api/sn_sc/servicecatalog/cart/{cart_item_id}
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
cart_item_id | Sys_id of the cart item to update. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
sysparm_quantity | Required. Quantity of the item to update the cart. Data type: String |
variables | Required if there are mandatory variables specified for the item. Object
consisting of all mandatory variable names-value pairs. Data type: Object |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
Service Catalog - PUT /sn_sc/servicecatalog/items/{sys_id}/submit_guide
Retrieves a list of items based on the needs described for an order guide.
URL format
Versioned URL: /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_guide
Default URL: /api/sn_sc/servicecatalog/items/{sys_id}/submit_guide
Supported request parameters
Name | Description |
---|---|
api_version | Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the
latest.
Data type: String |
sys_id | Sys_id of the order guide whose items are to be retrieved. Located in the Order
guide [sc_cat_item_guide] table. Data type: String |
Name | Description |
---|---|
None |
Name | Description |
---|---|
variables | Variables requested for an item. Each variable is a JSON object consisting of
name-value pairs. Data type: Array |
Headers
The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.
Header | Description |
---|---|
Accept | Data format of the response
body. Supported types: application/json or
application/xml.
Default: application/json |
Content-Type | Data format of the
request body. Supported types: application/json or
application/xml.
Default: application/json |
Header | Description |
---|---|
None |
Status codes
The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.
Response body parameters (JSON or XML)
Example: cURL request
On this page
- Service Catalog - DELETE /sn_sc/servicecatalog/cart/{cart_item_id}
- Service Catalog - DELETE /sn_sc/servicecatalog/cart/{sys_id}/empty
- Service Catalog - GET /sn_sc/servicecatalog/cart
- Service Catalog - GET /sn_sc/servicecatalog/cart/delivery_address/{user_id}
- Service Catalog - GET /sn_sc/servicecatalog/catalogs
- Service Catalog - GET /sn_sc/servicecatalog/catalogs/{sys_id}/categories
- Service Catalog - GET /sn_sc/servicecatalog/catalogs/{sys_id}
- Service Catalog - GET /sn_sc/servicecatalog/categories/{sys_id}
- Service Catalog - GET /sn_sc/servicecatalog/items
- Service Catalog - GET /sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}
- Service Catalog - GET /sn_sc/servicecatalog/items/{sys_id}
- Service Catalog - GET /sn_sc/servicecatalog/wishlist
- Service Catalog - GET /sn_sc/servicecatalog/wishlist/{cart_item_id}
- Service Catalog - POST /sn_sc/servicecatalog/cart/checkout
- Service Catalog - POST /sn_sc/servicecatalog/cart/submit_order
- Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart
- Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/add_to_wishlist
- Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/checkout_guide
- Service Catalog - POST /sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users
- Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/order_now
- Service Catalog - POST /sn_sc/servicecatalog/items/{sys_id}/submit_producer
- Service Catalog - POST /sn/sc/servicecatalog/variables/{sys_id}/display_value
- Service Catalog - PUT /sn_sc/servicecatalog/cart/{cart_item_id}
- Service Catalog - PUT /sn_sc/servicecatalog/items/{sys_id}/submit_guide