{"openapi":"3.0.3","info":{"title":"ServiceNow REST API (derived from documentation)","version":"zurich","description":"DERIVED BY SCRAPING, NOT VENDOR-PUBLISHED. ServiceNow generates OpenAPI only per-instance via the REST API Explorer. Methods, paths, query parameters and status codes are read from declared documentation markup; response schemas are deliberately NOT derived, because the docs state them only as prose. See x-scraped.","x-purplesuite-contract":{"system":"itsm","paint":"servicenow","revision":"zurich","documentScope":"bounded","scope":"GET /api/now/*","publishedOperations":126,"vendorOperationsInScope":70,"vendorOperations":577,"modeled":45,"unavailable":25,"note":"A PurpleSuite emulation of the ServiceNow REST API, bounded to the GET /api/now/* surface. Each in-scope operation is published in both the default and versioned URL forms the vendor serves.","sourceCaveat":"The pinned artifact is scraped, not vendor-published: ServiceNow generates OpenAPI only per-instance via the REST API Explorer. Its x-scraped.not_derived states response schemas, request body schemas, and parameter types were deliberately not derived. Every response schema in this document was therefore sourced from the official per-family documentation and is marked with x-purplesuite-response-source. See COVERAGE_LEDGER.md.","oauthBoundary":"The pinned document declares basicAuth and oauth2. Only HTTP Basic is hosted; the OAuth token endpoint /oauth_token.do is outside the GET /api/now/* scope, so no route accepts an OAuth bearer token."}},"servers":[{"url":"/api/purple-suite/{instanceId}/contracts/itsm/servicenow","description":"PurpleSuite instance-scoped ServiceNow emulation"}],"paths":{"/api/now/awa/agents/{user_id}":{"get":{"operationId":"get_awa_agent_get_now_awa_agents_user_id","summary":"AWA Agent - GET /now/awa/agents/{user_id}","tags":["AWA Agent API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Advanced Work Assignment (com.glide.awa) plugin and awa_integration_user role; docs state 403 when the glide.awa.enabled property is not true. Real-time agent presence and work routing is not a reproducible table read. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"Header","in":"query","required":false,"schema":{"type":"string"},"description":"Description"},{"name":"presence.channels.available","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether the channel is available. Possible values: true: Channel is available. false: Channel isn't available. Data type: Boolean"},{"name":"presence.channels.sys_id","in":"query","required":false,"schema":{"type":"string"},"description":"Channel sys_id. Data type: String Table: Service Channels [awa_service_channel]"},{"name":"presence.sys_id","in":"query","required":false,"schema":{"type":"string"},"description":"Presence state sys_id. Data type: String Table: Presence States [awa_presence_state]"}],"x-servicenow-versioned-url":"/api/now/{api_version}/awa/agents/{user_id}","x-servicenow-default-url":"/api/now/awa/agents/{user_id}","x-purplesuite-operation":{"vendorOperationId":"get_awa_agent_get_now_awa_agents_user_id","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/awa/agents/{user_id}":{"get":{"operationId":"get_awa_agent_get_now_awa_agents_user_id__versioned_url","summary":"AWA Agent - GET /now/awa/agents/{user_id}","tags":["AWA Agent API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Advanced Work Assignment (com.glide.awa) plugin and awa_integration_user role; docs state 403 when the glide.awa.enabled property is not true. Real-time agent presence and work routing is not a reproducible table read. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"Header","in":"query","required":false,"schema":{"type":"string"},"description":"Description"},{"name":"presence.channels.available","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether the channel is available. Possible values: true: Channel is available. false: Channel isn't available. Data type: Boolean"},{"name":"presence.channels.sys_id","in":"query","required":false,"schema":{"type":"string"},"description":"Channel sys_id. Data type: String Table: Service Channels [awa_service_channel]"},{"name":"presence.sys_id","in":"query","required":false,"schema":{"type":"string"},"description":"Presence state sys_id. Data type: String Table: Presence States [awa_presence_state]"}],"x-servicenow-versioned-url":"/api/now/{api_version}/awa/agents/{user_id}","x-servicenow-default-url":"/api/now/awa/agents/{user_id}","x-purplesuite-operation":{"vendorOperationId":"get_awa_agent_get_now_awa_agents_user_id","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/awa/agents/{user_id}/capacities":{"get":{"operationId":"get_awa_agent_get_now_awa_agents_user_id_capacities","summary":"AWA Agent - GET /now/awa/agents/{user_id}/capacities","tags":["AWA Agent API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Advanced Work Assignment (com.glide.awa) plugin and awa_integration_user role; docs state 403 when the glide.awa.enabled property is not true. Real-time agent presence and work routing is not a reproducible table read. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/awa/agents/{user_id}/capacities","x-servicenow-default-url":"/api/now/awa/agents/{user_id}/capacities","x-purplesuite-operation":{"vendorOperationId":"get_awa_agent_get_now_awa_agents_user_id_capacities","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/awa/agents/{user_id}/capacities":{"get":{"operationId":"get_awa_agent_get_now_awa_agents_user_id_capacities__versioned_url","summary":"AWA Agent - GET /now/awa/agents/{user_id}/capacities","tags":["AWA Agent API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Advanced Work Assignment (com.glide.awa) plugin and awa_integration_user role; docs state 403 when the glide.awa.enabled property is not true. Real-time agent presence and work routing is not a reproducible table read. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/awa/agents/{user_id}/capacities","x-servicenow-default-url":"/api/now/awa/agents/{user_id}/capacities","x-purplesuite-operation":{"vendorOperationId":"get_awa_agent_get_now_awa_agents_user_id_capacities","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/awa/agents/{user_id}/presence_states":{"get":{"operationId":"get_awa_agent_get_now_awa_agents_user_id_presence_states","summary":"AWA Agent - GET /now/awa/agents/{user_id}/presence_states","tags":["AWA Agent API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Advanced Work Assignment (com.glide.awa) plugin and awa_integration_user role; docs state 403 when the glide.awa.enabled property is not true. Real-time agent presence and work routing is not a reproducible table read. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/awa/agents/{user_id}/presence_states","x-servicenow-default-url":"/api/now/awa/agents/{user_id}/presence_states","x-purplesuite-operation":{"vendorOperationId":"get_awa_agent_get_now_awa_agents_user_id_presence_states","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/awa/agents/{user_id}/presence_states":{"get":{"operationId":"get_awa_agent_get_now_awa_agents_user_id_presence_states__versioned_url","summary":"AWA Agent - GET /now/awa/agents/{user_id}/presence_states","tags":["AWA Agent API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Advanced Work Assignment (com.glide.awa) plugin and awa_integration_user role; docs state 403 when the glide.awa.enabled property is not true. Real-time agent presence and work routing is not a reproducible table read. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/awa/agents/{user_id}/presence_states","x-servicenow-default-url":"/api/now/awa/agents/{user_id}/presence_states","x-purplesuite-operation":{"vendorOperationId":"get_awa_agent_get_now_awa_agents_user_id_presence_states","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/account":{"get":{"operationId":"get_account_get_now_account","summary":"Account - GET /now/account","tags":["Account API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/account-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. In the response, the boolean parameter hasMore is returned. It indicates whether there are more records to return that meet the filter criteria. Data type: Number Default: 10"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Do not pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. For example: sysparm_query=caller_id=javascript:gs.getUserID()^active=true The encoded query supports order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . For example, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filters all active records and orders the results in ascending order by number first, and then in descending order by category. If part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. You can control this behavior using the property glide.invalid_query.returns_no_rows . Set this property to true to return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"Element","in":"query","required":false,"schema":{"type":"string"},"description":"Description"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/account","x-servicenow-default-url":"/api/now/account","x-purplesuite-operation":{"vendorOperationId":"get_account_get_now_account","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/account":{"get":{"operationId":"get_account_get_now_account__versioned_url","summary":"Account - GET /now/account","tags":["Account API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/account-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. In the response, the boolean parameter hasMore is returned. It indicates whether there are more records to return that meet the filter criteria. Data type: Number Default: 10"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Do not pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. For example: sysparm_query=caller_id=javascript:gs.getUserID()^active=true The encoded query supports order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . For example, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filters all active records and orders the results in ascending order by number first, and then in descending order by category. If part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. You can control this behavior using the property glide.invalid_query.returns_no_rows . Set this property to true to return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"Element","in":"query","required":false,"schema":{"type":"string"},"description":"Description"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/account","x-servicenow-default-url":"/api/now/account","x-purplesuite-operation":{"vendorOperationId":"get_account_get_now_account","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/account/{id}":{"get":{"operationId":"get_account_get_now_account_id","summary":"Account - GET /now/account/{id}","tags":["Account API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates that the request is invalid.i89 Possible cause: Requested case doesn’t exist. User doesn’t have access to the account record."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/account-api.html","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/account/{id}","x-servicenow-default-url":"/api/now/account/{id}","x-purplesuite-operation":{"vendorOperationId":"get_account_get_now_account_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/account/{id}":{"get":{"operationId":"get_account_get_now_account_id__versioned_url","summary":"Account - GET /now/account/{id}","tags":["Account API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates that the request is invalid.i89 Possible cause: Requested case doesn’t exist. User doesn’t have access to the account record."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/account-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/account/{id}","x-servicenow-default-url":"/api/now/account/{id}","x-purplesuite-operation":{"vendorOperationId":"get_account_get_now_account_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/actsub/activities":{"get":{"operationId":"get_activitysubscriptions_get_now_actsub_activities","summary":"ActivitySubscriptions - GET /now/actsub/activities","tags":["ActivitySubscriptions API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected. The response body result.message parameter describes the nature of the error. Example error messages: Make sure a valid context and context_instance are passed or Make sure a valid stream and user are passed indicates that the request lacks one or both of the context and context_instance query parameters. These parameters are required. stFrom can not be greater than last indicates that the stFrom query parameter value exceeds the last query parameter value. Please provide start_date and end_date indicates that the request includes only one of the start_date and end_date query parameters, which cannot be used separately. start_date can not be ahead of end_date indicates that the specified start_date query parameter value occurs after the specified end_date query parameter value. Provided context is not configured in the system indicates that the context query parameter value does not represent a valid activity context. Make sure a valid context_instance is passed indicates that the context_instance query parameter value does not represent a valid instance of the specified activity context."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires activation of the Subscriptions and Activity Feed Framework (com.snc.activity_subscriptions) plugin and its activity-feed aggregation runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"before","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created prior to this date and time. Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"context","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Sys_id of an activity context. Predefined activity contexts include Consumer and Contact. Data type: String Table: Activity Context [sn_actsub_activity_context]"},{"name":"context_instance","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Sys_id of an instance of the specified activity context, representing the initiator of the activities you want to retrieve. Located in the appropriate table for the activity context. As an example, if you set context to the sys_id of the Consumer activity context, set this parameter to the sys_id of the Consumer [csm_consumer] table record for the consumer whose activities you want to retrieve. Data type: String"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by start_date and this parameter. Must be set along with start_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"facets","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of sys_ids of activity facet types to retrieve for the specified activity context. For more details on activity facets, see Create facets for activity contexts . Data type: String Default: Return all activity facet types configured for the activity context. Table: Activity Facet [sn_actsub_facet]"},{"name":"last","in":"query","required":false,"schema":{"type":"string"},"description":"Index value of the first result row omitted from the response body. The result row index starts at 0, so the last row included in the response body is the one with the index last -1. For example, setting last=5 omits rows with index 5 and above and returns at most only the first five result rows (with index values 0 through 4). Setting stFrom=1 and last=5 skips the first result row and returns the second through fifth result rows (with index values 1 through 4). Data type: Number (integer) Default: The value of the com.snc.actsub.activities.api.fetch.limit system property (10 by default)."},{"name":"record_id","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of a record to use when rendering dynamic facets. Located in the appropriate table for the activity type you want to retrieve. For example, if you want to fetch activities for a Case record, set this parameter to the sys_id of the Case record in question. For more details on dynamic facets, see Create facets for activity contexts . Data type: String"},{"name":"start_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by this parameter and end_date . Must be set along with end_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"stFrom","in":"query","required":false,"schema":{"type":"string"},"description":"Index value of the first result row to include in the response body. The result row index starts at 0. For example, stFrom=2 skips the first two result rows and returns results from the third row onward. Data type: Number (integer) Default: 0"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/actsub/activities","x-servicenow-default-url":"/api/now/actsub/activities","x-purplesuite-operation":{"vendorOperationId":"get_activitysubscriptions_get_now_actsub_activities","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/actsub/activities":{"get":{"operationId":"get_activitysubscriptions_get_now_actsub_activities__versioned_url","summary":"ActivitySubscriptions - GET /now/actsub/activities","tags":["ActivitySubscriptions API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected. The response body result.message parameter describes the nature of the error. Example error messages: Make sure a valid context and context_instance are passed or Make sure a valid stream and user are passed indicates that the request lacks one or both of the context and context_instance query parameters. These parameters are required. stFrom can not be greater than last indicates that the stFrom query parameter value exceeds the last query parameter value. Please provide start_date and end_date indicates that the request includes only one of the start_date and end_date query parameters, which cannot be used separately. start_date can not be ahead of end_date indicates that the specified start_date query parameter value occurs after the specified end_date query parameter value. Provided context is not configured in the system indicates that the context query parameter value does not represent a valid activity context. Make sure a valid context_instance is passed indicates that the context_instance query parameter value does not represent a valid instance of the specified activity context."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires activation of the Subscriptions and Activity Feed Framework (com.snc.activity_subscriptions) plugin and its activity-feed aggregation runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"before","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created prior to this date and time. Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"context","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Sys_id of an activity context. Predefined activity contexts include Consumer and Contact. Data type: String Table: Activity Context [sn_actsub_activity_context]"},{"name":"context_instance","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Sys_id of an instance of the specified activity context, representing the initiator of the activities you want to retrieve. Located in the appropriate table for the activity context. As an example, if you set context to the sys_id of the Consumer activity context, set this parameter to the sys_id of the Consumer [csm_consumer] table record for the consumer whose activities you want to retrieve. Data type: String"},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by start_date and this parameter. Must be set along with start_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"facets","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of sys_ids of activity facet types to retrieve for the specified activity context. For more details on activity facets, see Create facets for activity contexts . Data type: String Default: Return all activity facet types configured for the activity context. Table: Activity Facet [sn_actsub_facet]"},{"name":"last","in":"query","required":false,"schema":{"type":"string"},"description":"Index value of the first result row omitted from the response body. The result row index starts at 0, so the last row included in the response body is the one with the index last -1. For example, setting last=5 omits rows with index 5 and above and returns at most only the first five result rows (with index values 0 through 4). Setting stFrom=1 and last=5 skips the first result row and returns the second through fifth result rows (with index values 1 through 4). Data type: Number (integer) Default: The value of the com.snc.actsub.activities.api.fetch.limit system property (10 by default)."},{"name":"record_id","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of a record to use when rendering dynamic facets. Located in the appropriate table for the activity type you want to retrieve. For example, if you want to fetch activities for a Case record, set this parameter to the sys_id of the Case record in question. For more details on dynamic facets, see Create facets for activity contexts . Data type: String"},{"name":"start_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by this parameter and end_date . Must be set along with end_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"stFrom","in":"query","required":false,"schema":{"type":"string"},"description":"Index value of the first result row to include in the response body. The result row index starts at 0. For example, stFrom=2 skips the first two result rows and returns results from the third row onward. Data type: Number (integer) Default: 0"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/actsub/activities","x-servicenow-default-url":"/api/now/actsub/activities","x-purplesuite-operation":{"vendorOperationId":"get_activitysubscriptions_get_now_actsub_activities","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/actsub/facets/{activity_context}/{context_instance}":{"get":{"operationId":"get_activitysubscriptions_get_now_actsub_facets_activity_context_context_instance","summary":"ActivitySubscriptions - GET /now/actsub/facets/{activity_context}/{context_instance}","tags":["ActivitySubscriptions API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected. The response body result.message parameter describes the nature of the error. Example error messages: Make sure a valid activity context details are passed indicates that the activity_context path parameter value does not represent a valid activity context, the context_instance path parameter value does not represent a valid instance of the specified activity context, or both. Please provide start_date and end_date indicates that the request includes only one of the start_date and end_date query parameters, which cannot be used separately. start_date can not be ahead of end_date indicates that the specified start_date query parameter value occurs after the specified end_date query parameter value."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires activation of the Subscriptions and Activity Feed Framework (com.snc.activity_subscriptions) plugin and its activity-feed aggregation runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html","parameters":[{"name":"activity_context","in":"path","required":true,"schema":{"type":"string"}},{"name":"context_instance","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by start_date and this parameter. Must be set along with start_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"facets","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of sys_ids of activity facets to retrieve for the specified activity context. To see the activity facet types defined for an activity context, navigate to Customer Central > Customer Activity > Activity Contexts and examine the Facets related list. Data type: String Default: Return all activity facets configured for the activity context."},{"name":"get_activity_count","in":"query","required":false,"schema":{"type":"string"},"description":"Flag indicating whether or not to include activity counts for each facet in the response body. Valid values: true: Include facet activity counts. false: Omit facet activity counts. Data type: Boolean Default: false"},{"name":"lazy_load","in":"query","required":false,"schema":{"type":"string"},"description":"Flag indicating whether or not to improve performance by omitting facet activity data and activity counts from the response body. This parameter takes precedence over get_activity_count . Valid values: true: Omit facet activity data and activity counts. false: Retrieve facet activity data and activity counts. Data type: Boolean Default: false"},{"name":"start_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by this parameter and end_date . Must be set along with end_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}","x-servicenow-default-url":"/api/now/actsub/facets/{activity_context}/{context_instance}","x-purplesuite-operation":{"vendorOperationId":"get_activitysubscriptions_get_now_actsub_facets_activity_context_context_instance","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}":{"get":{"operationId":"get_activitysubscriptions_get_now_actsub_facets_activity_context_context_instance__versioned_url","summary":"ActivitySubscriptions - GET /now/actsub/facets/{activity_context}/{context_instance}","tags":["ActivitySubscriptions API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected. The response body result.message parameter describes the nature of the error. Example error messages: Make sure a valid activity context details are passed indicates that the activity_context path parameter value does not represent a valid activity context, the context_instance path parameter value does not represent a valid instance of the specified activity context, or both. Please provide start_date and end_date indicates that the request includes only one of the start_date and end_date query parameters, which cannot be used separately. start_date can not be ahead of end_date indicates that the specified start_date query parameter value occurs after the specified end_date query parameter value."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires activation of the Subscriptions and Activity Feed Framework (com.snc.activity_subscriptions) plugin and its activity-feed aggregation runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/actsub-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"activity_context","in":"path","required":true,"schema":{"type":"string"}},{"name":"context_instance","in":"path","required":true,"schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by start_date and this parameter. Must be set along with start_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"facets","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of sys_ids of activity facets to retrieve for the specified activity context. To see the activity facet types defined for an activity context, navigate to Customer Central > Customer Activity > Activity Contexts and examine the Facets related list. Data type: String Default: Return all activity facets configured for the activity context."},{"name":"get_activity_count","in":"query","required":false,"schema":{"type":"string"},"description":"Flag indicating whether or not to include activity counts for each facet in the response body. Valid values: true: Include facet activity counts. false: Omit facet activity counts. Data type: Boolean Default: false"},{"name":"lazy_load","in":"query","required":false,"schema":{"type":"string"},"description":"Flag indicating whether or not to improve performance by omitting facet activity data and activity counts from the response body. This parameter takes precedence over get_activity_count . Valid values: true: Omit facet activity data and activity counts. false: Retrieve facet activity data and activity counts. Data type: Boolean Default: false"},{"name":"start_date","in":"query","required":false,"schema":{"type":"string"},"description":"Date/time value. The request returns only records created during the time period defined by this parameter and end_date . Must be set along with end_date . Data type: String Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DD"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/actsub/facets/{activity_context}/{context_instance}","x-servicenow-default-url":"/api/now/actsub/facets/{activity_context}/{context_instance}","x-purplesuite-operation":{"vendorOperationId":"get_activitysubscriptions_get_now_actsub_facets_activity_context_context_instance","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/stats/{tableName}":{"get":{"operationId":"get_aggregate_get_now_stats_tablename","summary":"Aggregate - GET /now/stats/{tableName}","tags":["Aggregate API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AggregateResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Forbidden. The user doesn't have access rights to the specified record."},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AggregateAPI.html","parameters":[{"name":"tableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"name-value","in":"query","required":false,"schema":{"type":"string"},"description":"An alternative to using the sysparm_query parameter. You can filter a query using key-value pairs where the key is the name of a field. For example, instead of using the parameter &sysparm_query=active=true , you can use &active=true . You can use the display value when the field is a choice or reference type field, such as &state=closed instead of &state=7 . To specify multiple key-value pairs, separate each with an ampersand, such as &active=true&assigned_to=john.smith . Data type: String"},{"name":"sysparm_<aggregate>_fields","in":"query","required":false,"schema":{"type":"string"},"description":"List of fields on which to perform each aggregate operation. You can specify multiple fields by separating each with a comma. For example, to get the average values from the duration and priority fields, use sysparm_avg_fields=duration,priority . Note: Specify this parameter, the sysparm_count parameter, or both for your query to return meaningful results. If neither parameter is passed, no aggregate operation is performed. Data type: String"},{"name":"sysparm_count","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that determines whether to return the number of records returned by the query. Note: Specify this parameter, the sysparm_<aggregate>_fields parameter, or both for your query to return meaningful results. If neither parameter is passed, no aggregate operation is performed. Data type: String"},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Data retrieval operation when grouping by reference or choice fields. Based on this value, the query returns either the display value, the actual value in the database, or both. true: Returns display values for all fields. false: Returns actual values from the database. If a value is not specified, this parameter defaults to false. all: Returns both actual and display values. There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues as they are not read from the database and may reference other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905) . Data type: String"},{"name":"sysparm_group_by","in":"query","required":false,"schema":{"type":"string"},"description":"Fields by which to group the returned data. You can specify multiple fields by separating each field with a comma, such as sysparm_group_by=priority,state . Data type: String"},{"name":"sysparm_having","in":"query","required":false,"schema":{"type":"string"},"description":"Additional query that enables you to filter the data based on an aggregate operation. The value for this parameter must follow the syntax aggregate^field^operator^value , such as count^priority^>^3 to obtain the number of records within the query results with a priority greater than 3. You can specify multiple queries by separating each with a comma, such ascount^state^=^1,avg^priority^>^3 . Data type: String"},{"name":"sysparm_order_by","in":"query","required":false,"schema":{"type":"string"},"description":"List of values by which to order grouped results. You can specify an order using a field or an aggregate. For example, if you specify sysparm_order_by=AVG^state , groups of results with lower average state values are returned first. You can also order by COUNT to arrange groups of records by the number of records in each group. When you specify an order, groups are ordered in ascending order by default. Use ^DESC to sort in descending order, such as sysparm_order_by=state^DESC . Data type: String"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"An encoded query. For example: (sysparm_query=active=true)(sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/stats/{tableName}","x-servicenow-default-url":"/api/now/stats/{tableName}","x-purplesuite-operation":{"vendorOperationId":"get_aggregate_get_now_stats_tablename","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/stats/{tableName}":{"get":{"operationId":"get_aggregate_get_now_stats_tablename__versioned_url","summary":"Aggregate - GET /now/stats/{tableName}","tags":["Aggregate API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AggregateResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Forbidden. The user doesn't have access rights to the specified record."},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AggregateAPI.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"tableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"name-value","in":"query","required":false,"schema":{"type":"string"},"description":"An alternative to using the sysparm_query parameter. You can filter a query using key-value pairs where the key is the name of a field. For example, instead of using the parameter &sysparm_query=active=true , you can use &active=true . You can use the display value when the field is a choice or reference type field, such as &state=closed instead of &state=7 . To specify multiple key-value pairs, separate each with an ampersand, such as &active=true&assigned_to=john.smith . Data type: String"},{"name":"sysparm_<aggregate>_fields","in":"query","required":false,"schema":{"type":"string"},"description":"List of fields on which to perform each aggregate operation. You can specify multiple fields by separating each with a comma. For example, to get the average values from the duration and priority fields, use sysparm_avg_fields=duration,priority . Note: Specify this parameter, the sysparm_count parameter, or both for your query to return meaningful results. If neither parameter is passed, no aggregate operation is performed. Data type: String"},{"name":"sysparm_count","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that determines whether to return the number of records returned by the query. Note: Specify this parameter, the sysparm_<aggregate>_fields parameter, or both for your query to return meaningful results. If neither parameter is passed, no aggregate operation is performed. Data type: String"},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Data retrieval operation when grouping by reference or choice fields. Based on this value, the query returns either the display value, the actual value in the database, or both. true: Returns display values for all fields. false: Returns actual values from the database. If a value is not specified, this parameter defaults to false. all: Returns both actual and display values. There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues as they are not read from the database and may reference other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905) . Data type: String"},{"name":"sysparm_group_by","in":"query","required":false,"schema":{"type":"string"},"description":"Fields by which to group the returned data. You can specify multiple fields by separating each field with a comma, such as sysparm_group_by=priority,state . Data type: String"},{"name":"sysparm_having","in":"query","required":false,"schema":{"type":"string"},"description":"Additional query that enables you to filter the data based on an aggregate operation. The value for this parameter must follow the syntax aggregate^field^operator^value , such as count^priority^>^3 to obtain the number of records within the query results with a priority greater than 3. You can specify multiple queries by separating each with a comma, such ascount^state^=^1,avg^priority^>^3 . Data type: String"},{"name":"sysparm_order_by","in":"query","required":false,"schema":{"type":"string"},"description":"List of values by which to order grouped results. You can specify an order using a field or an aggregate. For example, if you specify sysparm_order_by=AVG^state , groups of results with lower average state values are returned first. You can also order by COUNT to arrange groups of records by the number of records in each group. When you specify an order, groups are ordered in ascending order by default. Use ^DESC to sort in descending order, such as sysparm_order_by=state^DESC . Data type: String"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"An encoded query. For example: (sysparm_query=active=true)(sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/stats/{tableName}","x-servicenow-default-url":"/api/now/stats/{tableName}","x-purplesuite-operation":{"vendorOperationId":"get_aggregate_get_now_stats_tablename","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cmdb/app_service/{sys_id}/getContent":{"get":{"operationId":"get_application_service_get_now_cmdb_app_service_sys_id_getcontent","summary":"Application Service - GET /now/cmdb/app_service/{sys_id}/getContent","tags":["Application Service API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or they do not have the app_service_admin role."},"403":{"description":"Not hosted by PurpleSuite. Requires the Service Mapping (com.snc.service-mapping) plugin and the app_service_admin role; service maps are produced by Discovery, not by seeded table state. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + external discovery","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/application-service-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/application-service-api.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"Mode","in":"query","required":false,"schema":{"type":"string"},"description":"Amount of relationship data to return. Valid values: Full: Return CI attributes and lookup information in addition to the data returned in shallow mode. Shallow: Return parent and child relationships between CIs within a service. The values are not case-sensitive. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-default-url":"/api/now/cmdb/app_service/{sys_id}/getContent","x-purplesuite-operation":{"vendorOperationId":"get_application_service_get_now_cmdb_app_service_sys_id_getcontent","classification":"unavailable","urlForm":"default"}}},"/api/now/cmdb/csdm/app_service/find_service":{"get":{"operationId":"get_application_service_get_now_cmdb_csdm_app_service_find_service","summary":"Application Service - GET /now/cmdb/csdm/app_service/find_service","tags":["Application Service API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or they do not have the app_service_admin role."},"403":{"description":"Not hosted by PurpleSuite. Requires the Service Mapping (com.snc.service-mapping) plugin and the app_service_admin role; service maps are produced by Discovery, not by seeded table state. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + external discovery","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/application-service-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/application-service-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"number","in":"query","required":false,"schema":{"type":"string"},"description":"Required, if name is not passed in. Unique number that identifies the application service for which to return information. Data type: String Table: Service Instance [cmdb_ci_service_auto]"}],"x-servicenow-default-url":"/api/now/cmdb/csdm/app_service/find_service","x-purplesuite-operation":{"vendorOperationId":"get_application_service_get_now_cmdb_csdm_app_service_find_service","classification":"unavailable","urlForm":"default"}}},"/api/now/attachment":{"get":{"operationId":"get_attachment_get_now_attachment","summary":"Attachment - GET /now/attachment","tags":["Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Limit to be applied on pagination. Note: Unusually large sysparm_limit values can impact system performance. Data type: String Default: 1000"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to exclude from the query. Use this parameter to get more records than specified in sysparm_limit parameter. For example, if sysparm_limit is set to 500, but there are additional records you want to query, you can specify a sysparm_offset parameter value of 500 to get the second set of records. Data type: String Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query. Queries for the Attachment API are relative to the Attachments [sys_attachment] table. For example: (sysparm_query=file_name=attachment.doc) The encoded query provides support for order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query. For example, sysparm_query=ORDERBYfile_name^ORDERBYDESCtable_Name orders the results in ascending order by name first, then in descending order by table name. Data type: String"}],"x-servicenow-versioned-url":"api/now/v1/attachment","x-servicenow-default-url":"api/now/attachment","x-purplesuite-operation":{"vendorOperationId":"get_attachment_get_now_attachment","classification":"modeled","urlForm":"default"}}},"/api/now/v1/attachment":{"get":{"operationId":"get_attachment_get_now_attachment__versioned_url","summary":"Attachment - GET /now/attachment","tags":["Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Limit to be applied on pagination. Note: Unusually large sysparm_limit values can impact system performance. Data type: String Default: 1000"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to exclude from the query. Use this parameter to get more records than specified in sysparm_limit parameter. For example, if sysparm_limit is set to 500, but there are additional records you want to query, you can specify a sysparm_offset parameter value of 500 to get the second set of records. Data type: String Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query. Queries for the Attachment API are relative to the Attachments [sys_attachment] table. For example: (sysparm_query=file_name=attachment.doc) The encoded query provides support for order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query. For example, sysparm_query=ORDERBYfile_name^ORDERBYDESCtable_Name orders the results in ascending order by name first, then in descending order by table name. Data type: String"}],"x-servicenow-versioned-url":"api/now/v1/attachment","x-servicenow-default-url":"api/now/attachment","x-purplesuite-operation":{"vendorOperationId":"get_attachment_get_now_attachment","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/attachment/{sys_id}":{"get":{"operationId":"get_attachment_get_now_attachment_sys_id","summary":"Attachment - GET /now/attachment/{sys_id}","tags":["Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates the specified attachment does not exist, or the current user cannot access it."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/v1/attachment/{sys_id}","x-servicenow-default-url":"/api/now/attachment/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_attachment_get_now_attachment_sys_id","classification":"modeled","urlForm":"default"}}},"/api/now/v1/attachment/{sys_id}":{"get":{"operationId":"get_attachment_get_now_attachment_sys_id__versioned_url","summary":"Attachment - GET /now/attachment/{sys_id}","tags":["Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates the specified attachment does not exist, or the current user cannot access it."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/v1/attachment/{sys_id}","x-servicenow-default-url":"/api/now/attachment/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_attachment_get_now_attachment_sys_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/attachment/{sys_id}/file":{"get":{"operationId":"get_attachment_get_now_attachment_sys_id_file","summary":"Attachment - GET /now/attachment/{sys_id}/file","tags":["Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"headers":{"X-Attachment-Metadata":{"description":"File metadata — size, name, and type — accompanying the binary body.","schema":{"type":"string"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/v1/attachment/{sys_id}/file","x-servicenow-default-url":"/api/now/attachment/{sys_id}/file","x-purplesuite-operation":{"vendorOperationId":"get_attachment_get_now_attachment_sys_id_file","classification":"modeled","urlForm":"default"}}},"/api/now/v1/attachment/{sys_id}/file":{"get":{"operationId":"get_attachment_get_now_attachment_sys_id_file__versioned_url","summary":"Attachment - GET /now/attachment/{sys_id}/file","tags":["Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"headers":{"X-Attachment-Metadata":{"description":"File metadata — size, name, and type — accompanying the binary body.","schema":{"type":"string"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/v1/attachment/{sys_id}/file","x-servicenow-default-url":"/api/now/attachment/{sys_id}/file","x-purplesuite-operation":{"vendorOperationId":"get_attachment_get_now_attachment_sys_id_file","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cilifecyclemgmt/actions/{sys_id}":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_actions_sys_id","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/actions/{sys_id}","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.ciActions parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}","x-servicenow-default-url":"/api/now/cilifecyclemgmt/actions/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_actions_sys_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_actions_sys_id__versioned_url","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/actions/{sys_id}","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.ciActions parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/actions/{sys_id}","x-servicenow-default-url":"/api/now/cilifecyclemgmt/actions/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_actions_sys_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cilifecyclemgmt/compatActions":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_compatactions","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/compatActions","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleBoolean"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"actionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of CI action to compare. Data type: String"},{"name":"otherActionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of CI action to compare. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/compatActions","x-servicenow-default-url":"/api/now/cilifecyclemgmt/compatActions","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_compatactions","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cilifecyclemgmt/compatActions":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_compatactions__versioned_url","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/compatActions","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleBoolean"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"actionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of CI action to compare. Data type: String"},{"name":"otherActionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of CI action to compare. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/compatActions","x-servicenow-default-url":"/api/now/cilifecyclemgmt/compatActions","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_compatactions","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cilifecyclemgmt/leases/{sys_id}/expired":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_leases_sys_id_expired","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/leases/{sys_id}/expired","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"actionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of the CI action applied to the specified CI. Data type: String"},{"name":"requestorId","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Sys_id of a workflow context, or an operator user ID returned from the CI Lifecycle Management - POST /now/cilifecyclemgmt/operators endpoint. Operator user IDs are located in the CI State Registered Users [statemgmt_register_users] table. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired","x-servicenow-default-url":"/api/now/cilifecyclemgmt/leases/{sys_id}/expired","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_leases_sys_id_expired","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_leases_sys_id_expired__versioned_url","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/leases/{sys_id}/expired","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"actionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of the CI action applied to the specified CI. Data type: String"},{"name":"requestorId","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Sys_id of a workflow context, or an operator user ID returned from the CI Lifecycle Management - POST /now/cilifecyclemgmt/operators endpoint. Operator user IDs are located in the CI State Registered Users [statemgmt_register_users] table. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/leases/{sys_id}/expired","x-servicenow-default-url":"/api/now/cilifecyclemgmt/leases/{sys_id}/expired","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_leases_sys_id_expired","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cilifecyclemgmt/notAllowedAction":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedaction","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedAction","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleBoolean"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"actionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of the CI action to check. Data type: String"},{"name":"ciClass","in":"query","required":false,"schema":{"type":"string"},"description":"Required. CI class. Data type: String"},{"name":"opsLabel","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Operational state to check. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/notAllowedAction","x-servicenow-default-url":"/api/now/cilifecyclemgmt/notAllowedAction","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedaction","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cilifecyclemgmt/notAllowedAction":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedaction__versioned_url","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedAction","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleBoolean"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"actionName","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of the CI action to check. Data type: String"},{"name":"ciClass","in":"query","required":false,"schema":{"type":"string"},"description":"Required. CI class. Data type: String"},{"name":"opsLabel","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Operational state to check. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/notAllowedAction","x-servicenow-default-url":"/api/now/cilifecyclemgmt/notAllowedAction","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedaction","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cilifecyclemgmt/notAllowedOpsTransition":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedopstransition","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedOpsTransition","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleBoolean"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"ciClass","in":"query","required":false,"schema":{"type":"string"},"description":"Required. CI class to check transition restrictions for. Data type: String"},{"name":"opsLabel","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Label of current CI operational state. Data type: String"},{"name":"transitionOpsLabel","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Label of operational state that is the target of the transition. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition","x-servicenow-default-url":"/api/now/cilifecyclemgmt/notAllowedOpsTransition","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedopstransition","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedopstransition__versioned_url","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/notAllowedOpsTransition","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleBoolean"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"ciClass","in":"query","required":false,"schema":{"type":"string"},"description":"Required. CI class to check transition restrictions for. Data type: String"},{"name":"opsLabel","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Label of current CI operational state. Data type: String"},{"name":"transitionOpsLabel","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Label of operational state that is the target of the transition. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/notAllowedOpsTransition","x-servicenow-default-url":"/api/now/cilifecyclemgmt/notAllowedOpsTransition","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_notallowedopstransition","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cilifecyclemgmt/requestors/{req_id}/valid":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_requestors_req_id_valid","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/requestors/{req_id}/valid","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"req_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid","x-servicenow-default-url":"/api/now/cilifecyclemgmt/requestors/{req_id}/valid","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_requestors_req_id_valid","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_requestors_req_id_valid__versioned_url","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/requestors/{req_id}/valid","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"req_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/requestors/{req_id}/valid","x-servicenow-default-url":"/api/now/cilifecyclemgmt/requestors/{req_id}/valid","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_requestors_req_id_valid","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cilifecyclemgmt/statuses/{sys_id}":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_statuses_sys_id","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/statuses/{sys_id}","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}","x-servicenow-default-url":"/api/now/cilifecyclemgmt/statuses/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_statuses_sys_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}":{"get":{"operationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_statuses_sys_id__versioned_url","summary":"CI Lifecycle Management - GET /now/cilifecyclemgmt/statuses/{sys_id}","tags":["CI Lifecycle Management API"],"responses":{"200":{"description":"Successful. The request was successfully processed by the endpoint. Review the response body result.result parameter to verify the outcome of the operation. If the endpoint encounters errors while processing the request, error codes and messages appear in the response body result.errors parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CiLifecycleResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cilifecyclemgmt/statuses/{sys_id}","x-servicenow-default-url":"/api/now/cilifecyclemgmt/statuses/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_ci_lifecycle_management_get_now_cilifecyclemgmt_statuses_sys_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cmdb/instance/{className}":{"get":{"operationId":"get_cmdb_instance_get_now_cmdb_instance_classname","summary":"CMDB Instance - GET /now/cmdb/instance/{classname}","tags":["CMDB Instance API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html","parameters":[{"name":"className","in":"path","required":true,"schema":{"type":"string"}},{"name":"className","in":"query","required":false,"schema":{"type":"string"},"description":"CMDB class name. This is the name of the table that contains the desired CI records, such as cmdb_ci_linux_server or cmdb_ci_apache_web_server. Data type: String"},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Don't pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. You can use a UI filter to obtain a properly encoded query. Syntax: sysparm_query=<col_name><operator><value> . Column names, operators, and values are case-sensitive. <col_name>: Name of the table column to filter on. <operator>: Supports the following values: = : <col_name> exactly matches <value>. != : <col_name> does not match <value>. LIKE : <col_name> contains the specified string <value>. Only works for <col_name> fields whose data type is string. STARTSWITH : <col_name> starts with the specified string <value>. Only works for <col_name> fields whose data type is string. ENDSWITH : <col_name> ends with the specified string <value>. Only works for <col_name> fields whose data type is string. ^ : AND operator to add an additional query condition. Records included in the result set match both conditions. ^OR : OR operator to add an additional query condition. Records included in the result set match at least one of the conditions. <value>: Value to filter on. For more information about operators, see Operators available for filters and queries . Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active. sysparm_query=caller_id=javascript:gs.getUserID()^active=true Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category. sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory By default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property glide.invalid_query.returns_no_rows to true to instead return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"classname","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cmdb/instance/{className}","x-servicenow-default-url":"/api/now/cmdb/instance/{className}","x-path-normalized":["reclassified 'classname' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_cmdb_instance_get_now_cmdb_instance_classname","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cmdb/instance/{className}":{"get":{"operationId":"get_cmdb_instance_get_now_cmdb_instance_classname__versioned_url","summary":"CMDB Instance - GET /now/cmdb/instance/{classname}","tags":["CMDB Instance API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"className","in":"path","required":true,"schema":{"type":"string"}},{"name":"className","in":"query","required":false,"schema":{"type":"string"},"description":"CMDB class name. This is the name of the table that contains the desired CI records, such as cmdb_ci_linux_server or cmdb_ci_apache_web_server. Data type: String"},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Don't pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. You can use a UI filter to obtain a properly encoded query. Syntax: sysparm_query=<col_name><operator><value> . Column names, operators, and values are case-sensitive. <col_name>: Name of the table column to filter on. <operator>: Supports the following values: = : <col_name> exactly matches <value>. != : <col_name> does not match <value>. LIKE : <col_name> contains the specified string <value>. Only works for <col_name> fields whose data type is string. STARTSWITH : <col_name> starts with the specified string <value>. Only works for <col_name> fields whose data type is string. ENDSWITH : <col_name> ends with the specified string <value>. Only works for <col_name> fields whose data type is string. ^ : AND operator to add an additional query condition. Records included in the result set match both conditions. ^OR : OR operator to add an additional query condition. Records included in the result set match at least one of the conditions. <value>: Value to filter on. For more information about operators, see Operators available for filters and queries . Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active. sysparm_query=caller_id=javascript:gs.getUserID()^active=true Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category. sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory By default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property glide.invalid_query.returns_no_rows to true to instead return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"classname","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cmdb/instance/{className}","x-servicenow-default-url":"/api/now/cmdb/instance/{className}","x-path-normalized":["reclassified 'classname' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_cmdb_instance_get_now_cmdb_instance_classname","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cmdb/instance/{className}/{sys_id}":{"get":{"operationId":"get_cmdb_instance_get_now_cmdb_instance_classname_sys_id","summary":"CMDB Instance - GET /now/cmdb/instance/{classname}/{sys_id}","tags":["CMDB Instance API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CmdbInstance"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html","parameters":[{"name":"className","in":"path","required":true,"schema":{"type":"string"}},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"className","in":"query","required":false,"schema":{"type":"string"},"description":"CMDB class name. This is the name of the table that contains the desired CI records, such as cmdb_ci_linux_server or cmdb_ci_apache_web_server. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"classname","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cmdb/instance/{className}/{sys_id}","x-servicenow-default-url":"/api/now/cmdb/instance/{className}/{sys_id}","x-path-normalized":["reclassified 'classname' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_cmdb_instance_get_now_cmdb_instance_classname_sys_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cmdb/instance/{className}/{sys_id}":{"get":{"operationId":"get_cmdb_instance_get_now_cmdb_instance_classname_sys_id__versioned_url","summary":"CMDB Instance - GET /now/cmdb/instance/{classname}/{sys_id}","tags":["CMDB Instance API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CmdbInstance"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"className","in":"path","required":true,"schema":{"type":"string"}},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"className","in":"query","required":false,"schema":{"type":"string"},"description":"CMDB class name. This is the name of the table that contains the desired CI records, such as cmdb_ci_linux_server or cmdb_ci_apache_web_server. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"classname","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cmdb/instance/{className}/{sys_id}","x-servicenow-default-url":"/api/now/cmdb/instance/{className}/{sys_id}","x-path-normalized":["reclassified 'classname' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_cmdb_instance_get_now_cmdb_instance_classname_sys_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/cmdb/meta/{className}":{"get":{"operationId":"get_cmdb_meta_get_now_cmdb_meta_classname","summary":"CMDB Meta - GET /now/cmdb/meta/{classname}","tags":["CMDB Meta API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CmdbMeta"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-meta-api.html","parameters":[{"name":"className","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"className","in":"query","required":false,"schema":{"type":"string"},"description":"CMDB class name. This is the name of the table that contains the desired CI records, such as cmdb_ci_linux_server or cmdb_ci_apache_web_server. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"classname","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cmdb/meta/{className}","x-servicenow-default-url":"/api/now/cmdb/meta/{className}","x-path-normalized":["reclassified 'classname' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_cmdb_meta_get_now_cmdb_meta_classname","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/cmdb/meta/{className}":{"get":{"operationId":"get_cmdb_meta_get_now_cmdb_meta_classname__versioned_url","summary":"CMDB Meta - GET /now/cmdb/meta/{classname}","tags":["CMDB Meta API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.CmdbMeta"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-meta-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"className","in":"path","required":true,"schema":{"type":"string"}},{"name":"className","in":"query","required":false,"schema":{"type":"string"},"description":"CMDB class name. This is the name of the table that contains the desired CI records, such as cmdb_ci_linux_server or cmdb_ci_apache_web_server. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"classname","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/cmdb/meta/{className}","x-servicenow-default-url":"/api/now/cmdb/meta/{className}","x-path-normalized":["reclassified 'classname' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_cmdb_meta_get_now_cmdb_meta_classname","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/v1/attachment_csm":{"get":{"operationId":"get_csm_attachment_get_now_attachment_csm","summary":"CSM Attachment - GET /now/attachment_csm","tags":["CSM Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/attachment_csm-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Don't pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Encoded query to use to search for attachments. This parameter must at least contain sysparm_query=table_name=<table> where <table> can only be those tables specified in the glide.rest.attachment_csm_api.allowed_tables property located in the System Properties [sys_properties] table. For example: sysparm_query=file_name=kb_knowledge . Syntax: sysparm_query=<col_name><operator><value> . <col_name>: Name of the table column to filter against. <operator>: Supports the following values: =: Exactly matches <value>. !=: Does not match <value>. ^: Logically AND multiple query statements. ^OR: Logically OR multiple query statements. LIKE: <col_name> contains the specified string. Only works for <col_name> fields whose data type is string. STARTSWITH: <col_name> starts with the specified string. Only works for <col_name> fields whose data type is string. ENDSWITH: <col_name> ends with the specified string. Only works for <col_name> fields whose data type is string. <value>: Value to match against. All parameters are case-sensitive. Queries can contain more than one entry, such as sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>] . For example: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Encoded queries also supports order by functionality. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> For example: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory This query filters all active records and orders the results in ascending order by number, and then in descending order by category. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/attachment_csm","x-servicenow-default-url":"/api/now/v1/attachment_csm","x-purplesuite-operation":{"vendorOperationId":"get_csm_attachment_get_now_attachment_csm","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/attachment_csm":{"get":{"operationId":"get_csm_attachment_get_now_attachment_csm__versioned_url","summary":"CSM Attachment - GET /now/attachment_csm","tags":["CSM Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/attachment_csm-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Don't pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Encoded query to use to search for attachments. This parameter must at least contain sysparm_query=table_name=<table> where <table> can only be those tables specified in the glide.rest.attachment_csm_api.allowed_tables property located in the System Properties [sys_properties] table. For example: sysparm_query=file_name=kb_knowledge . Syntax: sysparm_query=<col_name><operator><value> . <col_name>: Name of the table column to filter against. <operator>: Supports the following values: =: Exactly matches <value>. !=: Does not match <value>. ^: Logically AND multiple query statements. ^OR: Logically OR multiple query statements. LIKE: <col_name> contains the specified string. Only works for <col_name> fields whose data type is string. STARTSWITH: <col_name> starts with the specified string. Only works for <col_name> fields whose data type is string. ENDSWITH: <col_name> ends with the specified string. Only works for <col_name> fields whose data type is string. <value>: Value to match against. All parameters are case-sensitive. Queries can contain more than one entry, such as sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>] . For example: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Encoded queries also supports order by functionality. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> For example: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory This query filters all active records and orders the results in ascending order by number, and then in descending order by category. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/attachment_csm","x-servicenow-default-url":"/api/now/v1/attachment_csm","x-purplesuite-operation":{"vendorOperationId":"get_csm_attachment_get_now_attachment_csm","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/v1/attachment_csm/{sys_id}":{"get":{"operationId":"get_csm_attachment_get_now_attachment_csm_sys_id","summary":"CSM Attachment - GET /now/attachment_csm/{sys_id}","tags":["CSM Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentSingle"}}}},"400":{"description":"Bad Request. Indicates that the attachment from this table might not be accessible. Verify that the associated table is included in the glide.rest.attachment_csm_api.allowed_tables system property."},"401":{"description":"Unauthorized. The user credentials are incorrect."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not Found. Indicates the specified attachment does not exist, or the current user does not have the rights to access it."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/attachment_csm-api.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/attachment_csm/{sys_id}","x-servicenow-default-url":"/api/now/v1/attachment_csm/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_csm_attachment_get_now_attachment_csm_sys_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/attachment_csm/{sys_id}":{"get":{"operationId":"get_csm_attachment_get_now_attachment_csm_sys_id__versioned_url","summary":"CSM Attachment - GET /now/attachment_csm/{sys_id}","tags":["CSM Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.AttachmentSingle"}}}},"400":{"description":"Bad Request. Indicates that the attachment from this table might not be accessible. Verify that the associated table is included in the glide.rest.attachment_csm_api.allowed_tables system property."},"401":{"description":"Unauthorized. The user credentials are incorrect."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not Found. Indicates the specified attachment does not exist, or the current user does not have the rights to access it."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/attachment_csm-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/attachment_csm/{sys_id}","x-servicenow-default-url":"/api/now/v1/attachment_csm/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_csm_attachment_get_now_attachment_csm_sys_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/v1/attachment_csm/{sys_id}/file":{"get":{"operationId":"get_csm_attachment_get_now_attachment_csm_sys_id_file","summary":"CSM Attachment - GET /now/attachment_csm/{sys_id}/file","tags":["CSM Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"headers":{"X-Attachment-Metadata":{"description":"File metadata — size, name, and type — accompanying the binary body.","schema":{"type":"string"}}}},"400":{"description":"Bad Request. Indicates that the attachment from this table might not be accessible. Verify that the associated table is included in the glide.rest.attachment_csm_api.allowed_tables system property."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/attachment_csm-api.html","parameters":[{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/attachment_csm/{sys_id}/file","x-servicenow-default-url":"/api/now/v1/attachment_csm/{sys_id}/file","x-purplesuite-operation":{"vendorOperationId":"get_csm_attachment_get_now_attachment_csm_sys_id_file","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/attachment_csm/{sys_id}/file":{"get":{"operationId":"get_csm_attachment_get_now_attachment_csm_sys_id_file__versioned_url","summary":"CSM Attachment - GET /now/attachment_csm/{sys_id}/file","tags":["CSM Attachment API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"headers":{"X-Attachment-Metadata":{"description":"File metadata — size, name, and type — accompanying the binary body.","schema":{"type":"string"}}}},"400":{"description":"Bad Request. Indicates that the attachment from this table might not be accessible. Verify that the associated table is included in the glide.rest.attachment_csm_api.allowed_tables system property."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/attachment_csm-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/attachment_csm/{sys_id}/file","x-servicenow-default-url":"/api/now/v1/attachment_csm/{sys_id}/file","x-purplesuite-operation":{"vendorOperationId":"get_csm_attachment_get_now_attachment_csm_sys_id_file","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/sn_atf_tg/test_generation_progress":{"get":{"operationId":"get_cloud_runner_test_generation_get_now_sn_atf_tg_test_generation_progress","summary":"Cloud Runner Test Generation - GET /now/sn_atf_tg/test_generation_progress","tags":["Cloud Runner Test Generation REST API"],"responses":{"200":{"description":"Successfully retrieved the progress of the BOQ job."},"400":{"description":"Error getting BOQ record status. Returns one of the following messages: No BOQ ID passed in – No BOQ ID was provided. Add the BOQ ID to the request body. Unable to find BOQ record – Invalid Sys ID. Verify that the sys_id of the BOQ record is valid and the record exists."},"403":{"description":"Not hosted by PurpleSuite. AI-driven test generation executed by vendor-hosted Cloud Runner infrastructure. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"AI + vendor-hosted runner","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testgeneration-api.html"}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testgeneration-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"snboqId","in":"query","required":false,"schema":{"type":"string"},"description":"Required. The BOQ record sys_id of the test generation job to get the progress of. Data type: String Table: BOQ [sn_atf_tg_sn_boq]"}],"x-servicenow-default-url":"GET /api/now/sn_atf_tg/test_generation_progress","x-purplesuite-operation":{"vendorOperationId":"get_cloud_runner_test_generation_get_now_sn_atf_tg_test_generation_progress","classification":"unavailable","urlForm":"default","sourcePathKey":"/GET /api/now/sn_atf_tg/test_generation_progress","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/sn_atf_tg/test_runner_progress":{"get":{"operationId":"get_cloud_runner_test_runner_get_now_sn_atf_tg_test_runner_progress","summary":"Cloud Runner Test Runner - GET /now/sn_atf_tg/test_runner_progress","tags":["Cloud Runner Test Runner REST API"],"responses":{"200":{"description":"Successfully retrieved the progress of the BOQ job."},"400":{"description":"Error getting BOQ record status. Returns one of the following messages: No BOQ ID passed in – No BOQ ID was provided. Add the BOQ ID to the request body. Unable to find BOQ record – Invalid Sys ID. Verify that the sys_id of the BOQ record is valid and the record exists."},"403":{"description":"Not hosted by PurpleSuite. Test execution performed by vendor-hosted Cloud Runner infrastructure. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"vendor-hosted runner","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testrunner-api.html"}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testrunner-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"snboqId","in":"query","required":false,"schema":{"type":"string"},"description":"Required. The BOQ record sys_id of the test runner job to get the progress of. Data type: String Table: BOQ [sn_atf_tg_sn_boq]"}],"x-servicenow-default-url":"GET /api/now/sn_atf_tg/test_runner_progress","x-purplesuite-operation":{"vendorOperationId":"get_cloud_runner_test_runner_get_now_sn_atf_tg_test_runner_progress","classification":"unavailable","urlForm":"default","sourcePathKey":"/GET /api/now/sn_atf_tg/test_runner_progress","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/sn_atf_tg/is_valid_cloud_user":{"get":{"operationId":"get_cloud_runner_test_user_get_now_sn_atf_tg_is_valid_cloud_user","summary":"Cloud Runner Test User - GET /now/sn_atf_tg/is_valid_cloud_user","tags":["Cloud Runner Test User REST API"],"responses":{"200":{"description":"Returns true or false if the user is valid and satisfies cloud user criteria."},"403":{"description":"Not hosted by PurpleSuite. Cloud test user provisioning and validation performed by vendor-hosted Cloud Runner infrastructure. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"vendor-hosted runner","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testuser-api.html"}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testuser-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"username","in":"query","required":false,"schema":{"type":"string"},"description":"Required. User name of the sys_user to check if the user passes the following baseline criteria. Exists, Is active, Is not locked out, Needs a password reset, Is an admin, Is read-only, Is web services-only If any of these conditions fail, the API returns a false boolean with a message about which criteria failed. Data type: String"}],"x-servicenow-default-url":"GET /api/now/sn_atf_tg/is_valid_cloud_user","x-purplesuite-operation":{"vendorOperationId":"get_cloud_runner_test_user_get_now_sn_atf_tg_is_valid_cloud_user","classification":"unavailable","urlForm":"default","sourcePathKey":"/GET /api/now/sn_atf_tg/is_valid_cloud_user","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/sn_atf_tg/test_user_progress":{"get":{"operationId":"get_cloud_runner_test_user_get_now_sn_atf_tg_test_user_progress","summary":"Cloud Runner Test User - GET /now/sn_atf_tg/test_user_progress","tags":["Cloud Runner Test User REST API"],"responses":{"200":{"description":"Successfully retrieved the progress of the test user job."},"400":{"description":"Error getting BOQ record status. Returns one of the following messages: No BOQ ID passed in – No BOQ ID was provided. Add the BOQ ID to the request body. Unable to find BOQ record – Invalid Sys ID. Verify that the sys_id of the BOQ record is valid and the record exists."},"403":{"description":"Not hosted by PurpleSuite. Cloud test user provisioning and validation performed by vendor-hosted Cloud Runner infrastructure. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"vendor-hosted runner","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testuser-api.html"}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cloudrunner-testuser-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"snboqId","in":"query","required":false,"schema":{"type":"string"},"description":"Required. BOQ record sys_id of the test user job to get the progress of. Data Type: String Table: BOQ [sn_atf_tg_sn_boq]"}],"x-servicenow-default-url":"GET /api/now/sn_atf_tg/test_user_progress","x-purplesuite-operation":{"vendorOperationId":"get_cloud_runner_test_user_get_now_sn_atf_tg_test_user_progress","classification":"unavailable","urlForm":"default","sourcePathKey":"/GET /api/now/sn_atf_tg/test_user_progress","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/cmp_catalog_api/itemsbyciclass":{"get":{"operationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_itemsbyciclass","summary":"Cloud Services Catalog - GET /now/cmp_catalog_api/itemsbyciclass","tags":["Cloud Services Catalog API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Available only as a separate subscription requiring the ITOM Enterprise bundle or ITOM Cloud Accelerate entitlement plus the sn_cmp.cloud_service_user role, and needs configured cloud provider accounts. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"paid entitlement + external cloud","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"ci_class","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of the CI class to get the resource catalog items from (for example, \"cmdb_ci_vm_instance\"). Located in the Reference CI Type field in the Configuration Item [cmdb_ci] table. Data type: String"},{"name":"display_variables","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to list catalog item variables associated with each catalog item. Valid values: true: Displays list catalog item variables. false: Doesn't display list catalog item variables. Data type: Boolean Default: False"},{"name":"operation_name","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Name of the operation. Located in the Name column of the resource interface in the OperationSignature [sn_cmp_rb_op_signature] table. Note: This parameter can query part or whole of the operation. For example, if you want to list all interfaces starting with \"Servicenow\", you can set the variable as operation_name = Servicenow . Default: All catalog items of all operation types are returned. Data type: String"},{"name":"resource_interface","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Resource interface that the resource catalog item is hosted on. Located in the Name column of the ResourceInterfaces [sn_cmp_rb_resourceinterface] table. Data type: String"}],"x-servicenow-default-url":"/api/now/cmp_catalog_api/itemsbyciclass","x-purplesuite-operation":{"vendorOperationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_itemsbyciclass","classification":"unavailable","urlForm":"default"}}},"/api/now/cmp_catalog_api/itemsbyrb":{"get":{"operationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_itemsbyrb","summary":"Cloud Services Catalog - GET /now/cmp_catalog_api/itemsbyrb","tags":["Cloud Services Catalog API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Available only as a separate subscription requiring the ITOM Enterprise bundle or ITOM Cloud Accelerate entitlement plus the sn_cmp.cloud_service_user role, and needs configured cloud provider accounts. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"paid entitlement + external cloud","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"display_variables","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to list catalog item variables associated with each catalog item. Valid values: true: Displays list catalog item variables. false: Doesn't display list catalog item variables. Data type: Boolean Default: False"},{"name":"operation_name","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Name of the operation. Located in the Name column of the resource interface in the OperationSignature [sn_cmp_rb_op_signature] table. Note: This parameter can query part or whole of the operation. For example, if you want to list all interfaces starting with \"Servicenow\", you can set the variable as operation_name = Servicenow . Default: All catalog items of all operation types are returned. Data type: String"},{"name":"resource_block","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Name of the resource block to get its related resource operation catalog items from (for example, Virtual Server). Default: All catalog items of all operation types are returned. Data type: String Table: Resource Block [sn_cmp_rb_resourceblock]"},{"name":"resource_interface","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Resource interface that the resource catalog item is hosted on. Located in the Name column of the ResourceInterfaces [sn_cmp_rb_resourceinterface] table. Data type: String"}],"x-servicenow-default-url":"/api/now/cmp_catalog_api/itemsbyrb","x-purplesuite-operation":{"vendorOperationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_itemsbyrb","classification":"unavailable","urlForm":"default"}}},"/api/now/cmp_catalog_api/services":{"get":{"operationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_services","summary":"Cloud Services Catalog - GET /now/cmp_catalog_api/services","tags":["Cloud Services Catalog API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Available only as a separate subscription requiring the ITOM Enterprise bundle or ITOM Cloud Accelerate entitlement plus the sn_cmp.cloud_service_user role, and needs configured cloud provider accounts. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"paid entitlement + external cloud","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"catalog_type","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Type of catalog item. Accepted values (case-sensitive): Provision - Returns all Blueprint type catalog items. LifeCycle - Returns all Day 2 Operation type catalog items. If the input is empty (default), all services of both catalog types are returned. Data type: String"},{"name":"display_variables","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to list catalog item variables associated with each catalog item. Valid values: true: Displays list catalog item variables. false: Doesn't display list catalog item variables. Data type: Boolean Default: False"},{"name":"blueprint_name","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Name of the blueprint in which to fetch the related catalog items. Located in the Category Item [sn_cmp_bp_cat_item] table. Note: This parameter can query part or whole of the blueprint name. For example, if you want to list all blueprints starting with \"Servicenow\", you can set the variable as blueprint_name = Servicenow . Default: all services of all blueprints are returned. Data type: String"}],"x-servicenow-default-url":"/api/now/cmp_catalog_api/services","x-purplesuite-operation":{"vendorOperationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_services","classification":"unavailable","urlForm":"default"}}},"/api/now/cmp_catalog_api/stacks":{"get":{"operationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_stacks","summary":"Cloud Services Catalog - GET /now/cmp_catalog_api/stacks","tags":["Cloud Services Catalog API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Available only as a separate subscription requiring the ITOM Enterprise bundle or ITOM Cloud Accelerate entitlement plus the sn_cmp.cloud_service_user role, and needs configured cloud provider accounts. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"paid entitlement + external cloud","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"blueprint_name","in":"query","required":false,"schema":{"type":"string"},"description":"Optional. Name of the blueprint in which to fetch the related catalog items. Located in the Category Item [sn_cmp_bp_cat_item] table. Note: This parameter can query part or whole of the blueprint name. For example, if you want to list all blueprints starting with \"Servicenow\", you can set the variable as blueprint_name = Servicenow . Default: all services of all blueprints are returned. Data type: String"},{"name":"display_variables","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to list catalog item variables associated with each catalog item. Valid values: true: Displays list catalog item variables. false: Doesn't display list catalog item variables. Data type: Boolean Default: False"}],"x-servicenow-default-url":"/api/now/cmp_catalog_api/stacks","x-purplesuite-operation":{"vendorOperationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_stacks","classification":"unavailable","urlForm":"default"}}},"/api/now/cmp_catalog_api/status":{"get":{"operationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_status","summary":"Cloud Services Catalog - GET /now/cmp_catalog_api/status","tags":["Cloud Services Catalog API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Available only as a separate subscription requiring the ITOM Enterprise bundle or ITOM Cloud Accelerate entitlement plus the sn_cmp.cloud_service_user role, and needs configured cloud provider accounts. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"paid entitlement + external cloud","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"405":{"description":"Invalid method. The functionality is disabled."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cs-catalog-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"req_item","in":"query","required":false,"schema":{"type":"string"},"description":"Unique request item number in the Requested Item [sc_req_item] table. For example, RITM0000001 . Data type: String"}],"x-servicenow-default-url":"/api/now/cmp_catalog_api/status","x-purplesuite-operation":{"vendorOperationId":"get_cloud_services_catalog_get_now_cmp_catalog_api_status","classification":"unavailable","urlForm":"default"}}},"/api/now/consumer":{"get":{"operationId":"get_consumer_get_now_consumer","summary":"Consumer - GET /now/consumer","tags":["Consumer API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/consumer-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. In the response, the boolean parameter hasMore is returned. It indicates whether there are more records to return that meet the filter criteria. Data type: Number Default: 10"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Do not pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. For example: sysparm_query=caller_id=javascript:gs.getUserID()^active=true The encoded query supports order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . For example, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filters all active records and orders the results in ascending order by number first, and then in descending order by category. If part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. You can control this behavior using the property glide.invalid_query.returns_no_rows . Set this property to true to return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"Element","in":"query","required":false,"schema":{"type":"string"},"description":"Description"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/consumer","x-servicenow-default-url":"/api/now/consumer","x-purplesuite-operation":{"vendorOperationId":"get_consumer_get_now_consumer","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/consumer":{"get":{"operationId":"get_consumer_get_now_consumer__versioned_url","summary":"Consumer - GET /now/consumer","tags":["Consumer API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/consumer-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. In the response, the boolean parameter hasMore is returned. It indicates whether there are more records to return that meet the filter criteria. Data type: Number Default: 10"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Do not pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. For example: sysparm_query=caller_id=javascript:gs.getUserID()^active=true The encoded query supports order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . For example, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filters all active records and orders the results in ascending order by number first, and then in descending order by category. If part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. You can control this behavior using the property glide.invalid_query.returns_no_rows . Set this property to true to return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"Element","in":"query","required":false,"schema":{"type":"string"},"description":"Description"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/consumer","x-servicenow-default-url":"/api/now/consumer","x-purplesuite-operation":{"vendorOperationId":"get_consumer_get_now_consumer","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/consumer/{id}":{"get":{"operationId":"get_consumer_get_now_consumer_id","summary":"Consumer - GET /now/consumer/{id}","tags":["Consumer API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates that the request is invalid. Could be due to one of the following reasons: Requested case doesn't exist. User doesn't have access to the consumer record."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/consumer-api.html","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/consumer/{id}","x-servicenow-default-url":"/api/now/consumer/{id}","x-purplesuite-operation":{"vendorOperationId":"get_consumer_get_now_consumer_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/consumer/{id}":{"get":{"operationId":"get_consumer_get_now_consumer_id__versioned_url","summary":"Consumer - GET /now/consumer/{id}","tags":["Consumer API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates that the request is invalid. Could be due to one of the following reasons: Requested case doesn't exist. User doesn't have access to the consumer record."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/consumer-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/consumer/{id}","x-servicenow-default-url":"/api/now/consumer/{id}","x-purplesuite-operation":{"vendorOperationId":"get_consumer_get_now_consumer_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/contact":{"get":{"operationId":"get_contact_get_now_contact","summary":"Contact - GET /now/contact","tags":["Contact API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/contact-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. In the response, the boolean parameter hasMore is returned. It indicates whether there are more records to return that meet the filter criteria. Data type: Number Default: 10"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Do not pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. For example: sysparm_query=caller_id=javascript:gs.getUserID()^active=true The encoded query supports order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . For example, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filters all active records and orders the results in ascending order by number first, and then in descending order by category. If part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. You can control this behavior using the property glide.invalid_query.returns_no_rows . Set this property to true to return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/contact","x-servicenow-default-url":"/api/now/contact","x-purplesuite-operation":{"vendorOperationId":"get_contact_get_now_contact","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/contact":{"get":{"operationId":"get_contact_get_now_contact__versioned_url","summary":"Contact - GET /now/contact","tags":["Contact API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/contact-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of records to return. For requests that exceed this number of records, use the sysparm_offset parameter to paginate record retrieval. In the response, the boolean parameter hasMore is returned. It indicates whether there are more records to return that meet the filter criteria. Data type: Number Default: 10"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Do not pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. For example: sysparm_query=caller_id=javascript:gs.getUserID()^active=true The encoded query supports order by . To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . For example, sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory filters all active records and orders the results in ascending order by number first, and then in descending order by category. If part of the query is invalid, such as by specifying an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. You can control this behavior using the property glide.invalid_query.returns_no_rows . Set this property to true to return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/contact","x-servicenow-default-url":"/api/now/contact","x-purplesuite-operation":{"vendorOperationId":"get_contact_get_now_contact","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/contact/{id}":{"get":{"operationId":"get_contact_get_now_contact_id","summary":"Contact - GET /now/contact/{id}","tags":["Contact API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates that the request is invalid. Could be due to one of the following reasons: Requested case doesn't exist. User doesn't have access to the case."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/contact-api.html","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/contact/{id}","x-servicenow-default-url":"/api/now/contact/{id}","x-purplesuite-operation":{"vendorOperationId":"get_contact_get_now_contact_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/contact/{id}":{"get":{"operationId":"get_contact_get_now_contact_id__versioned_url","summary":"Contact - GET /now/contact/{id}","tags":["Contact API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates that the request is invalid. Could be due to one of the following reasons: Requested case doesn't exist. User doesn't have access to the case."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/contact-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/contact/{id}","x-servicenow-default-url":"/api/now/contact/{id}","x-purplesuite-operation":{"vendorOperationId":"get_contact_get_now_contact_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/data_classification/getAllDataClasses":{"get":{"operationId":"get_data_classification_get_data_classification_getalldataclasses","summary":"Data Classification - GET /data_classification/getAllDataClasses","tags":["Data Classification API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.DataClasses"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/data-classification-api.html","parameters":[{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-default-url":"/api/now/data_classification/getAllDataClasses","x-purplesuite-operation":{"vendorOperationId":"get_data_classification_get_data_classification_getalldataclasses","classification":"modeled","urlForm":"default"}}},"/api/now/email/{id}":{"get":{"operationId":"get_email_get_now_email_id","summary":"Email - GET /now/email/{id}","tags":["Email API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Indicates the record is not found or the requesting user does not have access to the record. Verify the user has the proper role and access permissions."},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/email-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_fields","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-default-url":"Versioned URL: /api/now/{api_version}/email/{id}","x-purplesuite-operation":{"vendorOperationId":"get_email_get_now_email_id","classification":"modeled","urlForm":"default","sourcePathKey":"/Versioned URL: /api/now/{api_version}/email/{id}","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/{api_version}/email/{id}":{"get":{"operationId":"get_email_get_now_email_id__versioned_url","summary":"Email - GET /now/email/{id}","tags":["Email API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Indicates the record is not found or the requesting user does not have access to the record. Verify the user has the proper role and access permissions."},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/email-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"api_version","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"sysparm_fields","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-default-url":"Versioned URL: /api/now/{api_version}/email/{id}","x-purplesuite-operation":{"vendorOperationId":"get_email_get_now_email_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation.","sourcePathKey":"/Versioned URL: /api/now/{api_version}/email/{id}","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/import/{stagingTableName}/{sys_id}":{"get":{"operationId":"get_import_set_get_now_import_stagingtablename_sys_id","summary":"Import Set - GET /now/import/{stagingTableName}/{sys_id}","tags":["Import Set API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ImportSetResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates the specified resource was not available. As import set tables are deleted frequently based on a schedule, GET requests may return 404 Not Found responses if the transformation result no longer exists."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_ImportSetAPI.html","parameters":[{"name":"stagingTableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/import/{stagingTableName}/{sys_id}","x-servicenow-default-url":"/api/now/import/{stagingTableName}/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_import_set_get_now_import_stagingtablename_sys_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/import/{stagingTableName}/{sys_id}":{"get":{"operationId":"get_import_set_get_now_import_stagingtablename_sys_id__versioned_url","summary":"Import Set - GET /now/import/{stagingTableName}/{sys_id}","tags":["Import Set API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ImportSetResult"}}}},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Indicates the specified resource was not available. As import set tables are deleted frequently based on a schedule, GET requests may return 404 Not Found responses if the transformation result no longer exists."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_ImportSetAPI.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"stagingTableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/import/{stagingTableName}/{sys_id}","x-servicenow-default-url":"/api/now/import/{stagingTableName}/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_import_set_get_now_import_stagingtablename_sys_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/clotho/table/{table}/{subject}/{metric}":{"get":{"operationId":"get_metricbase_time_series_get_now_clotho_table_table_subject_metric","summary":"MetricBase Time Series - GET /now/clotho/table/{table}/{subject}/{metric}","tags":["MetricBase Time Series API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Usable only when the MetricBase plugin (com.snc.clotho) is installed and activated, backed by a separate time-series datastore. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + datastore","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html","parameters":[{"name":"table","in":"path","required":true,"schema":{"type":"string"}},{"name":"subject","in":"path","required":true,"schema":{"type":"string"}},{"name":"metric","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to label the result data with the subject record display value if no other label is specified. Valid values: true: Result data is labeled with the subject record display value. false: Result data is not labeled with the subject record display value. Data type: Boolean Default: false"},{"name":"sysparm_end","in":"query","required":false,"schema":{"type":"string"},"description":"Required. End time of the evaluation period. An empty or missing value is treated as the current time. Time values are inclusive of this end time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 . Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"sysparm_start","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Start time of the evaluation period. The special value all can be used to set the start time as the current time minus the maximum retention period for the specified metrics. An empty or missing value is treated as an implicit all . Time values are inclusive of this start time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/clotho/table/{table}/{subject}/{metric}","x-purplesuite-operation":{"vendorOperationId":"get_metricbase_time_series_get_now_clotho_table_table_subject_metric","classification":"unavailable","urlForm":"default","sourcePathKey":"/now/clotho/table/{table}/{subject}/{metric}","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/{api_version}/clotho/table/{table}/{subject}/{metric}":{"get":{"operationId":"get_metricbase_time_series_get_now_clotho_table_table_subject_metric__versioned_url","summary":"MetricBase Time Series - GET /now/clotho/table/{table}/{subject}/{metric}","tags":["MetricBase Time Series API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Usable only when the MetricBase plugin (com.snc.clotho) is installed and activated, backed by a separate time-series datastore. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + datastore","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"table","in":"path","required":true,"schema":{"type":"string"}},{"name":"subject","in":"path","required":true,"schema":{"type":"string"}},{"name":"metric","in":"path","required":true,"schema":{"type":"string"}},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to label the result data with the subject record display value if no other label is specified. Valid values: true: Result data is labeled with the subject record display value. false: Result data is not labeled with the subject record display value. Data type: Boolean Default: false"},{"name":"sysparm_end","in":"query","required":false,"schema":{"type":"string"},"description":"Required. End time of the evaluation period. An empty or missing value is treated as the current time. Time values are inclusive of this end time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 . Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"sysparm_start","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Start time of the evaluation period. The special value all can be used to set the start time as the current time minus the maximum retention period for the specified metrics. An empty or missing value is treated as an implicit all . Time values are inclusive of this start time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/clotho/table/{table}/{subject}/{metric}","x-purplesuite-operation":{"vendorOperationId":"get_metricbase_time_series_get_now_clotho_table_table_subject_metric","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation.","sourcePathKey":"/now/clotho/table/{table}/{subject}/{metric}","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/clotho/transform/{table}/{metric}":{"get":{"operationId":"get_metricbase_time_series_get_now_clotho_transform_table_metric","summary":"MetricBase Time Series - GET /now/clotho/transform/{table}/{metric}","tags":["MetricBase Time Series API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Usable only when the MetricBase plugin (com.snc.clotho) is installed and activated, backed by a separate time-series datastore. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + datastore","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html","parameters":[{"name":"table","in":"path","required":true,"schema":{"type":"string"}},{"name":"metric","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to label the result data with the subject record display value if no other label is specified. Valid values: true: Result data is labeled with the subject record display value. false: Result data is not labeled with the subject record display value. Data type: Boolean Default: false"},{"name":"sysparm_end","in":"query","required":false,"schema":{"type":"string"},"description":"Required. End time of the evaluation period. An empty or missing value is treated as the current time. Time values are inclusive of this end time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 . Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query string for finding the subject records. Data type: String Default: None"},{"name":"sysparm_start","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Start time of the evaluation period. The special value all can be used to set the start time as the current time minus the maximum retention period for the specified metrics. An empty or missing value is treated as an implicit all . Time values are inclusive of this start time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"sysparm_subject_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Limit size of the subject query result. Data type: Number Default: 10,000"},{"name":"sysparm_transforms","in":"query","required":false,"schema":{"type":"string"},"description":"Comma separated list of transforms. Valid transforms: add avg label mul resample sum top Data type: String Default: None"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/clotho/transform/{table}/{metric}","x-purplesuite-operation":{"vendorOperationId":"get_metricbase_time_series_get_now_clotho_transform_table_metric","classification":"unavailable","urlForm":"default","sourcePathKey":"/now/clotho/transform/{table}/{metric}","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/{api_version}/clotho/transform/{table}/{metric}":{"get":{"operationId":"get_metricbase_time_series_get_now_clotho_transform_table_metric__versioned_url","summary":"MetricBase Time Series - GET /now/clotho/transform/{table}/{metric}","tags":["MetricBase Time Series API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Usable only when the MetricBase plugin (com.snc.clotho) is installed and activated, backed by a separate time-series datastore. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + datastore","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/Clotho-Time-Series-API.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"table","in":"path","required":true,"schema":{"type":"string"}},{"name":"metric","in":"path","required":true,"schema":{"type":"string"}},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to label the result data with the subject record display value if no other label is specified. Valid values: true: Result data is labeled with the subject record display value. false: Result data is not labeled with the subject record display value. Data type: Boolean Default: false"},{"name":"sysparm_end","in":"query","required":false,"schema":{"type":"string"},"description":"Required. End time of the evaluation period. An empty or missing value is treated as the current time. Time values are inclusive of this end time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 . Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query string for finding the subject records. Data type: String Default: None"},{"name":"sysparm_start","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Start time of the evaluation period. The special value all can be used to set the start time as the current time minus the maximum retention period for the specified metrics. An empty or missing value is treated as an implicit all . Time values are inclusive of this start time. Data type: String Format: ISO 8601 (UTC), either: Absolute date format [YYYY-MM-DDThh:mm:ss], such as 2019-03-20T17:04:55 Relative to current time duration format [P(n)Y(n)M(n)DT(n)H(n)M(n)S] , such as P1M ."},{"name":"sysparm_subject_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Limit size of the subject query result. Data type: Number Default: 10,000"},{"name":"sysparm_transforms","in":"query","required":false,"schema":{"type":"string"},"description":"Comma separated list of transforms. Valid transforms: add avg label mul resample sum top Data type: String Default: None"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/clotho/transform/{table}/{metric}","x-purplesuite-operation":{"vendorOperationId":"get_metricbase_time_series_get_now_clotho_transform_table_metric","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation.","sourcePathKey":"/now/clotho/transform/{table}/{metric}","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/agent_intelligence/solution/prediction":{"get":{"operationId":"get_predictive_intelligence_get_agent_intelligence_solution_prediction","summary":"Predictive Intelligence - GET /agent_intelligence/solution/prediction","tags":["Predictive Intelligence API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Usable only when the Predictive Intelligence (com.glide.platform_ml) plugin is activated, and returns the output of a trained ML model. A synthesised prediction, confidence and threshold would be invented output. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"ML model","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-intelligence-api.html"}},"404":{"description":"Not found. The requested item wasn't found."},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-intelligence-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"input_filter","in":"query","required":false,"schema":{"type":"string"},"description":"Required parameter if input_table is used, don't use this parameter with input_maps parameter. Filter to select records on which to run predictions. For example: sys_id 0ef47232db801300864adfea5e961912 Data type: String"},{"name":"input_maps","in":"query","required":false,"schema":{"type":"string"},"description":"Required unless using input_table parameter. Array of input name-value pairs. For example: [{\"short_description\":\"my email is not working\"}, {\"short_description\":\"need help with password\"}] Data type: Array of Objects"},{"name":"input_table","in":"query","required":false,"schema":{"type":"string"},"description":"Required unless using input_maps parameter. Table name on which you want to run predictions. For example: incident Data type: String"},{"name":"options","in":"query","required":false,"schema":{"type":"string"},"description":"JSON object with optional arguments. For example: {\"top_n\" : 5, \"apply_threshold\":false} Valid options: top_n: Number. If provided, returns the top results, up to the specified number of predictions. apply_threshold: Boolean. Checks the threshold value for the solution and applies it to the result set. The threshold value is solution threshold for similarity or class-level threshold for classification. Default value is true. custom_results_filter: String. Similarity solutions only. Specifies the allowed set from which results are returned using an encoded query. Data type: Object"},{"name":"solution_names","in":"query","required":false,"schema":{"type":"string"},"description":"Required. Comma-separated list of solution names for which you want to run predictions. For example: ml_incident_categorization,ml_incident_assignment Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-default-url":"/now/agent_intelligence/solution/prediction","x-purplesuite-operation":{"vendorOperationId":"get_predictive_intelligence_get_agent_intelligence_solution_prediction","classification":"unavailable","urlForm":"default","sourcePathKey":"/now/agent_intelligence/solution/prediction","repair":"Repaired per x-catalog-notice.actually_required; the pinned source is unchanged."}}},"/api/now/agent_intelligence/solution/{solution_name}/prediction":{"get":{"operationId":"get_predictive_intelligence_get_agent_intelligence_solution_solution_name_prediction","summary":"Predictive Intelligence - GET /agent_intelligence/solution/{solution_name}/prediction","tags":["Predictive Intelligence API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Usable only when the Predictive Intelligence (com.glide.platform_ml) plugin is activated, and returns the output of a trained ML model. A synthesised prediction, confidence and threshold would be invented output. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"ML model","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-intelligence-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-intelligence-api.html","parameters":[{"name":"solution_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"Solution","in":"query","required":false,"schema":{"type":"string"},"description":"Name-value pair of the solution input field. For example, enter the name: short_description and the value: Unable to connect to VPN . Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/now/{api_version}/agent_intelligence/solution/prediction","x-servicenow-default-url":"/api/now/agent_intelligence/solution/{solution_name}/prediction","x-purplesuite-operation":{"vendorOperationId":"get_predictive_intelligence_get_agent_intelligence_solution_solution_name_prediction","classification":"unavailable","urlForm":"default"}}},"/now/{api_version}/agent_intelligence/solution/prediction":{"get":{"operationId":"get_predictive_intelligence_get_agent_intelligence_solution_solution_name_prediction__versioned_url","summary":"Predictive Intelligence - GET /agent_intelligence/solution/{solution_name}/prediction","tags":["Predictive Intelligence API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Usable only when the Predictive Intelligence (com.glide.platform_ml) plugin is activated, and returns the output of a trained ML model. A synthesised prediction, confidence and threshold would be invented output. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"ML model","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-intelligence-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/agent-intelligence-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"solution_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"Solution","in":"query","required":false,"schema":{"type":"string"},"description":"Name-value pair of the solution input field. For example, enter the name: short_description and the value: Unable to connect to VPN . Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/now/{api_version}/agent_intelligence/solution/prediction","x-servicenow-default-url":"/api/now/agent_intelligence/solution/{solution_name}/prediction","x-purplesuite-operation":{"vendorOperationId":"get_predictive_intelligence_get_agent_intelligence_solution_solution_name_prediction","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/pa/scorecards":{"get":{"operationId":"get_scorecards_get_now_pa_scorecards","summary":"Scorecards - GET /now/pa/scorecards","tags":["Scorecards API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the pa_viewer role, and indicator scores exist only after Performance Analytics historical data collection jobs have run. Synthesised scorecard scores would be invented output. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"role + data-collection subsystem","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_PerformanceAnalyticsAPI.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_PerformanceAnalyticsAPI.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_breakdown","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of a breakdown to return chart information organized as defined by the breakdown. For example, the sys_id of a priority breakdown to return separate task chart information for each priority value, such as the number of open incidents / Priority / 2 - High. Data type: String"},{"name":"sysparm_breakdown_relation","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of a breakdown relation to break down the returned data using that relation. Data type: String"},{"name":"sysparm_contains","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of names or descriptions to return results only from indicators with a matching value. All the comma-separated list items must match, or no results are returned: The list follows AND logic, not OR logic. Data type: String"},{"name":"sysparm_display","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates the type of indicators to return. Valid values: true: Return only indicators that display on the Analytics Hub . all: Return all indicators. Data type: String Default: true"},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user's time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record. Data type: String Valid values: true: Returns the display values for all fields. false: Returns the actual values from the database. all: Returns both actual and display values. Default: false Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905)."},{"name":"sysparm_elements_filter","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of an elements filter to apply to the returned data. Data type: String"},{"name":"sysparm_exclude_reference_link","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to hide additional information provided for reference fields, such as the URI to the reference resource. Valid values: true: Hide additional information provided for reference fields. false: Do not hide additional information provided for reference fields. Data type: Boolean Default: false"},{"name":"sysparm_favorites","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return only indicators that are favorites of the querying user. Valid values: true: Return only indicators that are favorites of the querying user. false: Return all indicators. Data type: Boolean Default: false"},{"name":"sysparm_from","in":"query","required":false,"schema":{"type":"string"},"description":"Earliest date to return scores from. Only scores from this date or later are returned. This parameter requires that include_scores is set to true . Format: ISO-8601 standard Date type: String"},{"name":"sysparm_include_aggregates","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all possible aggregates for an indicator, including aggregates that have already been applied. Valid values: true: Return all possible aggregates for an indicator, including aggregates that have already been applied. false: Return no aggregates. Data type: Boolean Default: false"},{"name":"sysparm_include_available_aggregates","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all available aggregates for an indicator when no aggregate has been applied. Valid values: true: Return all available aggregates for an indicator when no aggregate has been applied. false: Return no aggregates. Data type: Boolean Default: false"},{"name":"sysparm_include_available_breakdowns","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all available breakdowns for an indicator. Valid values: true: Return all available breakdowns for an indicator. false: Return no breakdowns. Data type: Boolean Default: false"},{"name":"sysparm_include_forecast_scores","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the forecast_scores element that contains an array of date-value pairs that define the forecast data for the Analytics Hub . This parameter requires that the include_scores parameter is also set to true . Valid values: true: Return the forecast_scores element. false: Do not return the forecast_scores element. Data type: Boolean Default: false"},{"name":"sysparm_include_realtime","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the realtime_enabled element which indicates if real-time scores are enabled for the indicator, and the realtime_value element which contains the real-time score value. This parameter is not supported for formula indicators. Valid values: true: Return the realtime_enabled element. false: Do not return the realtime_enabled element. Data type: Boolean Default: false"},{"name":"sysparm_include_score_notes","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added. Valid values: true: Return all notes associated with the score. false: Do not return all notes associated with the score. Data type: Boolean Default: false"},{"name":"sysparm_include_scores","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return indicator scores for the entire time range selected on the Analytics Hub . If a value is not specified, this parameter defaults to false and returns only the most recent score value. To constrain the date range of the scores that are returned, combine this parameter with from and to . Valid values: true: Return indicator scores for the entire selected time range. false: Do not return indicator scores for the entire selected time range. Data type: Boolean Default: false"},{"name":"sysparm_include_target_color_scheme","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the target_color_scheme element that contains the minimum and maximum values, and the color of each section of the target color scheme for the Analytics Hub . Valid values: true: Return the target_color_scheme element. false: Do not return the target_color_scheme element. Data type: Boolean Default: false"},{"name":"sysparm_include_trendline_scores","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the trendline_scores element that contains an array of date-value pairs that define the Analytics Hub trendline. This parameter requires that the include_scores parameter is also set to true . Valid values: true: Return the trendline_scores element. false: Do not return the trendline_scores element. Data type: Boolean Default: false"},{"name":"sysparm_key","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return results only for key indicators. Valid values: true: Return the trendline_scores element. false: Do not return the trendline_scores element . Data type: Boolean Default: false"},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of scores to return. Data type: Number"},{"name":"sysparm_page","in":"query","required":false,"schema":{"type":"string"},"description":"Page number. For example, when querying 20 indicators with the default sysparm_per_page value (10), specify a sysparm_page value of 2 to retrieve indicators 11-20. Data type: Number"},{"name":"sysparm_per_page","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of indicators each query can return on a page. Default: 10 Maximum: 100 Data type: Number"},{"name":"sysparm_sortby","in":"query","required":false,"schema":{"type":"string"},"description":"Value to use when sorting results. Valid values: bullet change changeperc date default direction duedate frequency gap gapperc group indicator_group name order target trend value Data type: String Default: value"},{"name":"sysparm_sortdir","in":"query","required":false,"schema":{"type":"string"},"description":"Sort direction. Valid values: asc: Denotes ascending des: Denotes descending Data type: String Default: Descending"},{"name":"sysparm_step","in":"query","required":false,"schema":{"type":"string"},"description":"Numeric value to skip scores, based on the indicator frequency. For example, specify a value of 3 to return only scores from every third day for a daily indicator, or from every third week for a weekly indicator. Data type: Number"},{"name":"sysparm_tags","in":"query","required":false,"schema":{"type":"string"},"description":"Indicator group sys_id in which to return the indicators of that group. Do not use sysparm_uuid with this parameter. You cannot obtain the sys_id of an indicator group through this API. Instead, get the sys_id from the indicator group record. For more information about obtaining sys_ids from records, see Unique record identifier (sys_id) . Data type: String"},{"name":"sysparm_target","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return results only for indicators that have a target set on the Analytics Hub . Valid values: true: Only return results for indicators that have a target set. false: Return results for all applicable indicators. Data type: Boolean Default: false"},{"name":"sysparm_to","in":"query","required":false,"schema":{"type":"string"},"description":"Latest date from which to return scores. Only scores from this date or earlier are returned. This parameter requires that include_scores is set to true . Data type: String Format: ISO-8601 standard"},{"name":"sysparm_uuid","in":"query","required":false,"schema":{"type":"string"},"description":"Colon-separated list of sys_id values to specify which indicators, breakdowns, aggregates, and domains to query. The parameter follows this format: <indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id or element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id or element_sys_ids>:<aggregate_sys_id>;<domain_sys_id> The parameter must begin with the sys_id of an indicator record. Optionally, you can append the sys_id values of a breakdown and breakdown element to group the response based on the breakdown, and the sys_id of an aggregate to apply that aggregate. You can use a breakdown with an aggregate, or use only one. Note: If an indicator is configured to use a Default time series , all values that this API retrieves for that indicator use the selected aggregate. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/pa/scorecards","x-servicenow-default-url":"/api/now/pa/scorecards","x-purplesuite-operation":{"vendorOperationId":"get_scorecards_get_now_pa_scorecards","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/pa/scorecards":{"get":{"operationId":"get_scorecards_get_now_pa_scorecards__versioned_url","summary":"Scorecards - GET /now/pa/scorecards","tags":["Scorecards API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the pa_viewer role, and indicator scores exist only after Performance Analytics historical data collection jobs have run. Synthesised scorecard scores would be invented output. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"role + data-collection subsystem","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_PerformanceAnalyticsAPI.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_PerformanceAnalyticsAPI.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"sysparm_breakdown","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of a breakdown to return chart information organized as defined by the breakdown. For example, the sys_id of a priority breakdown to return separate task chart information for each priority value, such as the number of open incidents / Priority / 2 - High. Data type: String"},{"name":"sysparm_breakdown_relation","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of a breakdown relation to break down the returned data using that relation. Data type: String"},{"name":"sysparm_contains","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of names or descriptions to return results only from indicators with a matching value. All the comma-separated list items must match, or no results are returned: The list follows AND logic, not OR logic. Data type: String"},{"name":"sysparm_display","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates the type of indicators to return. Valid values: true: Return only indicators that display on the Analytics Hub . all: Return all indicators. Data type: String Default: true"},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user's time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record. Data type: String Valid values: true: Returns the display values for all fields. false: Returns the actual values from the database. all: Returns both actual and display values. Default: false Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905)."},{"name":"sysparm_elements_filter","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of an elements filter to apply to the returned data. Data type: String"},{"name":"sysparm_exclude_reference_link","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to hide additional information provided for reference fields, such as the URI to the reference resource. Valid values: true: Hide additional information provided for reference fields. false: Do not hide additional information provided for reference fields. Data type: Boolean Default: false"},{"name":"sysparm_favorites","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return only indicators that are favorites of the querying user. Valid values: true: Return only indicators that are favorites of the querying user. false: Return all indicators. Data type: Boolean Default: false"},{"name":"sysparm_from","in":"query","required":false,"schema":{"type":"string"},"description":"Earliest date to return scores from. Only scores from this date or later are returned. This parameter requires that include_scores is set to true . Format: ISO-8601 standard Date type: String"},{"name":"sysparm_include_aggregates","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all possible aggregates for an indicator, including aggregates that have already been applied. Valid values: true: Return all possible aggregates for an indicator, including aggregates that have already been applied. false: Return no aggregates. Data type: Boolean Default: false"},{"name":"sysparm_include_available_aggregates","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all available aggregates for an indicator when no aggregate has been applied. Valid values: true: Return all available aggregates for an indicator when no aggregate has been applied. false: Return no aggregates. Data type: Boolean Default: false"},{"name":"sysparm_include_available_breakdowns","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all available breakdowns for an indicator. Valid values: true: Return all available breakdowns for an indicator. false: Return no breakdowns. Data type: Boolean Default: false"},{"name":"sysparm_include_forecast_scores","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the forecast_scores element that contains an array of date-value pairs that define the forecast data for the Analytics Hub . This parameter requires that the include_scores parameter is also set to true . Valid values: true: Return the forecast_scores element. false: Do not return the forecast_scores element. Data type: Boolean Default: false"},{"name":"sysparm_include_realtime","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the realtime_enabled element which indicates if real-time scores are enabled for the indicator, and the realtime_value element which contains the real-time score value. This parameter is not supported for formula indicators. Valid values: true: Return the realtime_enabled element. false: Do not return the realtime_enabled element. Data type: Boolean Default: false"},{"name":"sysparm_include_score_notes","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added. Valid values: true: Return all notes associated with the score. false: Do not return all notes associated with the score. Data type: Boolean Default: false"},{"name":"sysparm_include_scores","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return indicator scores for the entire time range selected on the Analytics Hub . If a value is not specified, this parameter defaults to false and returns only the most recent score value. To constrain the date range of the scores that are returned, combine this parameter with from and to . Valid values: true: Return indicator scores for the entire selected time range. false: Do not return indicator scores for the entire selected time range. Data type: Boolean Default: false"},{"name":"sysparm_include_target_color_scheme","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the target_color_scheme element that contains the minimum and maximum values, and the color of each section of the target color scheme for the Analytics Hub . Valid values: true: Return the target_color_scheme element. false: Do not return the target_color_scheme element. Data type: Boolean Default: false"},{"name":"sysparm_include_trendline_scores","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return the trendline_scores element that contains an array of date-value pairs that define the Analytics Hub trendline. This parameter requires that the include_scores parameter is also set to true . Valid values: true: Return the trendline_scores element. false: Do not return the trendline_scores element. Data type: Boolean Default: false"},{"name":"sysparm_key","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return results only for key indicators. Valid values: true: Return the trendline_scores element. false: Do not return the trendline_scores element . Data type: Boolean Default: false"},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of scores to return. Data type: Number"},{"name":"sysparm_page","in":"query","required":false,"schema":{"type":"string"},"description":"Page number. For example, when querying 20 indicators with the default sysparm_per_page value (10), specify a sysparm_page value of 2 to retrieve indicators 11-20. Data type: Number"},{"name":"sysparm_per_page","in":"query","required":false,"schema":{"type":"string"},"description":"Maximum number of indicators each query can return on a page. Default: 10 Maximum: 100 Data type: Number"},{"name":"sysparm_sortby","in":"query","required":false,"schema":{"type":"string"},"description":"Value to use when sorting results. Valid values: bullet change changeperc date default direction duedate frequency gap gapperc group indicator_group name order target trend value Data type: String Default: value"},{"name":"sysparm_sortdir","in":"query","required":false,"schema":{"type":"string"},"description":"Sort direction. Valid values: asc: Denotes ascending des: Denotes descending Data type: String Default: Descending"},{"name":"sysparm_step","in":"query","required":false,"schema":{"type":"string"},"description":"Numeric value to skip scores, based on the indicator frequency. For example, specify a value of 3 to return only scores from every third day for a daily indicator, or from every third week for a weekly indicator. Data type: Number"},{"name":"sysparm_tags","in":"query","required":false,"schema":{"type":"string"},"description":"Indicator group sys_id in which to return the indicators of that group. Do not use sysparm_uuid with this parameter. You cannot obtain the sys_id of an indicator group through this API. Instead, get the sys_id from the indicator group record. For more information about obtaining sys_ids from records, see Unique record identifier (sys_id) . Data type: String"},{"name":"sysparm_target","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to return results only for indicators that have a target set on the Analytics Hub . Valid values: true: Only return results for indicators that have a target set. false: Return results for all applicable indicators. Data type: Boolean Default: false"},{"name":"sysparm_to","in":"query","required":false,"schema":{"type":"string"},"description":"Latest date from which to return scores. Only scores from this date or earlier are returned. This parameter requires that include_scores is set to true . Data type: String Format: ISO-8601 standard"},{"name":"sysparm_uuid","in":"query","required":false,"schema":{"type":"string"},"description":"Colon-separated list of sys_id values to specify which indicators, breakdowns, aggregates, and domains to query. The parameter follows this format: <indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id or element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id or element_sys_ids>:<aggregate_sys_id>;<domain_sys_id> The parameter must begin with the sys_id of an indicator record. Optionally, you can append the sys_id values of a breakdown and breakdown element to group the response based on the breakdown, and the sys_id of an aggregate to apply that aggregate. You can use a breakdown with an aggregate, or use only one. Note: If an indicator is configured to use a Default time series , all values that this API retrieves for that indicator use the selected aggregate. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/pa/scorecards","x-servicenow-default-url":"/api/now/pa/scorecards","x-purplesuite-operation":{"vendorOperationId":"get_scorecards_get_now_pa_scorecards","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/js/debugpoints/script/{tableName}/{sysId}/{fieldName}":{"get":{"operationId":"get_script_debugger_get_js_debugpoints_script_tablename_sysid_fieldname","summary":"Script Debugger - GET /js/debugpoints/script/{tableName}/{sysId}/{fieldName}","tags":["Script Debugger API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"403":{"description":"Not hosted by PurpleSuite. Requires the script_debugger role and an attached live server-side script execution/debug session. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"role + live engine","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scriptdebugger-api.html"}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scriptdebugger-api.html","parameters":[{"name":"tableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"sysId","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldName","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-default-url":"/api/now/js/debugpoints/script/{tableName}/{sysId}/{fieldName}","x-purplesuite-operation":{"vendorOperationId":"get_script_debugger_get_js_debugpoints_script_tablename_sysid_fieldname","classification":"unavailable","urlForm":"default"}}},"/api/now/scim/Companies":{"get":{"operationId":"get_scim_get_scim_companies","summary":"SCIM - GET /scim/Companies","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all companies whose name starts with \"Acme\", enter displayName SW \"Acme\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all companies whose name starts with \"Acme\" and were last modified before October 3, 2021, enter displayName SW \"Acme\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Companies","x-servicenow-default-url":"/api/now/scim/Companies","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_companies","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Companies":{"get":{"operationId":"get_scim_get_scim_companies__versioned_url","summary":"SCIM - GET /scim/Companies","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all companies whose name starts with \"Acme\", enter displayName SW \"Acme\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all companies whose name starts with \"Acme\" and were last modified before October 3, 2021, enter displayName SW \"Acme\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Companies","x-servicenow-default-url":"/api/now/scim/Companies","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_companies","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/CoostCenters/{cost_center_id}":{"get":{"operationId":"get_scim_get_scim_costcenters_cost_center_id","summary":"SCIM - GET /scim/CostCenters/{cost_center_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"cost_center_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/CostCenters/{cost_center_id}","x-servicenow-default-url":"/api/now/scim/CoostCenters/{cost_center_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_costcenters_cost_center_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/CostCenters/{cost_center_id}":{"get":{"operationId":"get_scim_get_scim_costcenters_cost_center_id__versioned_url","summary":"SCIM - GET /scim/CostCenters/{cost_center_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"cost_center_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/CostCenters/{cost_center_id}","x-servicenow-default-url":"/api/now/scim/CoostCenters/{cost_center_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_costcenters_cost_center_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/CostCenters":{"get":{"operationId":"get_scim_get_scim_costcenters","summary":"SCIM - GET /scim/CostCenters","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all cost center whose name starts with \"HR\", enter displayName SW \"HR\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all cost center whose name starts with \"HR\" and were last modified before October 3, 2021, enter displayName SW \"HR\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/CostCenters","x-servicenow-default-url":"/api/now/scim/CostCenters","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_costcenters","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/CostCenters":{"get":{"operationId":"get_scim_get_scim_costcenters__versioned_url","summary":"SCIM - GET /scim/CostCenters","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all cost center whose name starts with \"HR\", enter displayName SW \"HR\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all cost center whose name starts with \"HR\" and were last modified before October 3, 2021, enter displayName SW \"HR\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/CostCenters","x-servicenow-default-url":"/api/now/scim/CostCenters","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_costcenters","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Departments":{"get":{"operationId":"get_scim_get_scim_departments","summary":"SCIM - GET /scim/Departments","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all departments whose name starts with \"Engineer\", enter displayName SW \"Engineer\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all departments whose name starts with \"Engineer\" and were last modified before October 3, 2021, enter displayName SW \"Engineer\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Departments","x-servicenow-default-url":"/api/now/scim/Departments","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_departments","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Departments":{"get":{"operationId":"get_scim_get_scim_departments__versioned_url","summary":"SCIM - GET /scim/Departments","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all departments whose name starts with \"Engineer\", enter displayName SW \"Engineer\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all departments whose name starts with \"Engineer\" and were last modified before October 3, 2021, enter displayName SW \"Engineer\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Departments","x-servicenow-default-url":"/api/now/scim/Departments","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_departments","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Departments/{department_id}":{"get":{"operationId":"get_scim_get_scim_departments_deparment_id","summary":"SCIM - GET /scim/Departments/{deparment_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"department_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"department_id","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of the department record to return. Data type: String"},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"deparment_id","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Departments/{department_id}","x-servicenow-default-url":"/api/now/scim/Departments/{department_id}","x-path-normalized":["reclassified 'deparment_id' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_departments_deparment_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Departments/{department_id}":{"get":{"operationId":"get_scim_get_scim_departments_deparment_id__versioned_url","summary":"SCIM - GET /scim/Departments/{deparment_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"department_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"department_id","in":"query","required":false,"schema":{"type":"string"},"description":"Sys_id of the department record to return. Data type: String"},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}},{"name":"deparment_id","in":"query","schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Departments/{department_id}","x-servicenow-default-url":"/api/now/scim/Departments/{department_id}","x-path-normalized":["reclassified 'deparment_id' from path to query (absent from the route)"],"x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_departments_deparment_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Groups":{"get":{"operationId":"get_scim_get_scim_groups","summary":"SCIM - GET /scim/Groups","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all groups whose name starts with \"HR\", enter displayName SW \"HR\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all groups whose name starts with \"HR\" and were last modified before October 3, 2021, enter displayName SW \"HR\" AND meta.lastModified lt \"2021-10-33T00:00:00Z\" . Use dot-walking to specify nested attributes. Only the following SCIM group fields are available for use in filters: displayName externalId: Only supports EQ operator. id meta.created meta.lastModified Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Groups","x-servicenow-default-url":"/api/now/scim/Groups","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_groups","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Groups":{"get":{"operationId":"get_scim_get_scim_groups__versioned_url","summary":"SCIM - GET /scim/Groups","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all groups whose name starts with \"HR\", enter displayName SW \"HR\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all groups whose name starts with \"HR\" and were last modified before October 3, 2021, enter displayName SW \"HR\" AND meta.lastModified lt \"2021-10-33T00:00:00Z\" . Use dot-walking to specify nested attributes. Only the following SCIM group fields are available for use in filters: displayName externalId: Only supports EQ operator. id meta.created meta.lastModified Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Groups","x-servicenow-default-url":"/api/now/scim/Groups","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_groups","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Groups/{company_id}":{"get":{"operationId":"get_scim_get_scim_companies_company_id","summary":"SCIM - GET /scim/Companies/{company_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Companies/{company_id}","x-servicenow-default-url":"/api/now/scim/Groups/{company_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_companies_company_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Companies/{company_id}":{"get":{"operationId":"get_scim_get_scim_companies_company_id__versioned_url","summary":"SCIM - GET /scim/Companies/{company_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"company_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Companies/{company_id}","x-servicenow-default-url":"/api/now/scim/Groups/{company_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_companies_company_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Groups/{group_id}":{"get":{"operationId":"get_scim_get_scim_groups_group_id","summary":"SCIM - GET /scim/Groups/{group_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Groups/{group_id}","x-servicenow-default-url":"/api/now/scim/Groups/{group_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_groups_group_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Groups/{group_id}":{"get":{"operationId":"get_scim_get_scim_groups_group_id__versioned_url","summary":"SCIM - GET /scim/Groups/{group_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"group_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Groups/{group_id}","x-servicenow-default-url":"/api/now/scim/Groups/{group_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_groups_group_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Locations":{"get":{"operationId":"get_scim_get_scim_locations","summary":"SCIM - GET /scim/Locations","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all locations whose name starts with \"Ch\", enter displayName SW \"Ch\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all locations whose name starts with \"Ch\" and were last modified before October 3, 2021, enter displayName SW \"Ch\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Locations","x-servicenow-default-url":"/api/now/scim/Locations","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_locations","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Locations":{"get":{"operationId":"get_scim_get_scim_locations__versioned_url","summary":"SCIM - GET /scim/Locations","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported by this method. For example, to filter for all locations whose name starts with \"Ch\", enter displayName SW \"Ch\" . To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all locations whose name starts with \"Ch\" and were last modified before October 3, 2021, enter displayName SW \"Ch\" AND meta.lastModified lt \"2021-10-03T00:00:00Z\" . Use dot-walking to specify nested attributes. Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use those parameters available for filtering for the sortBy parameter, except that externalId is not allowed. For values that are null: sorted by ascending: Null values are sorted to the top. sorted by descending: Null values are sorted to the bottom. Data type: String Default: No sort"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Locations","x-servicenow-default-url":"/api/now/scim/Locations","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_locations","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Locations/{location_id}":{"get":{"operationId":"get_scim_get_scim_locations_location_id","summary":"SCIM - GET /scim/Locations/{location_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"location_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Locations/{location_id}","x-servicenow-default-url":"/api/now/scim/Locations/{location_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_locations_location_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Locations/{location_id}":{"get":{"operationId":"get_scim_get_scim_locations_location_id__versioned_url","summary":"SCIM - GET /scim/Locations/{location_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"location_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Locations/{location_id}","x-servicenow-default-url":"/api/now/scim/Locations/{location_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_locations_location_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/ResourceTypes":{"get":{"operationId":"get_scim_get_scim_resourcetypes","summary":"SCIM - GET /scim/ResourceTypes","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/ResourceTypes","x-servicenow-default-url":"/api/now/scim/ResourceTypes","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_resourcetypes","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/ResourceTypes":{"get":{"operationId":"get_scim_get_scim_resourcetypes__versioned_url","summary":"SCIM - GET /scim/ResourceTypes","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/ResourceTypes","x-servicenow-default-url":"/api/now/scim/ResourceTypes","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_resourcetypes","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/ResourceTypes/{ResourceName}":{"get":{"operationId":"get_scim_get_scim_resourcetypes_resourcename","summary":"SCIM - GET /scim/ResourceTypes/{ResourceName}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"ResourceName","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/ResourceTypes/{ResourceName}","x-servicenow-default-url":"/api/now/scim/ResourceTypes/{ResourceName}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_resourcetypes_resourcename","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/ResourceTypes/{ResourceName}":{"get":{"operationId":"get_scim_get_scim_resourcetypes_resourcename__versioned_url","summary":"SCIM - GET /scim/ResourceTypes/{ResourceName}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"ResourceName","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/ResourceTypes/{ResourceName}","x-servicenow-default-url":"/api/now/scim/ResourceTypes/{ResourceName}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_resourcetypes_resourcename","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Schemas":{"get":{"operationId":"get_scim_get_scim_schemas","summary":"SCIM - GET /scim/Schemas","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Schemas","x-servicenow-default-url":"/api/now/scim/Schemas","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_schemas","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Schemas":{"get":{"operationId":"get_scim_get_scim_schemas__versioned_url","summary":"SCIM - GET /scim/Schemas","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Schemas","x-servicenow-default-url":"/api/now/scim/Schemas","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_schemas","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Schemas/{SchemaName}":{"get":{"operationId":"get_scim_get_scim_schemas_schemaname","summary":"SCIM - GET /scim/Schemas/{SchemaName}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"SchemaName","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Schemas/{SchemaName}","x-servicenow-default-url":"/api/now/scim/Schemas/{SchemaName}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_schemas_schemaname","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Schemas/{SchemaName}":{"get":{"operationId":"get_scim_get_scim_schemas_schemaname__versioned_url","summary":"SCIM - GET /scim/Schemas/{SchemaName}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"SchemaName","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Schemas/{SchemaName}","x-servicenow-default-url":"/api/now/scim/Schemas/{SchemaName}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_schemas_schemaname","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/ServiceProviderConfig":{"get":{"operationId":"get_scim_get_scim_serviceproviderconfig","summary":"SCIM - GET /scim/ServiceProviderConfig","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/ServiceProviderConfig","x-servicenow-default-url":"/api/now/scim/ServiceProviderConfig","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_serviceproviderconfig","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/ServiceProviderConfig":{"get":{"operationId":"get_scim_get_scim_serviceproviderconfig__versioned_url","summary":"SCIM - GET /scim/ServiceProviderConfig","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/ServiceProviderConfig","x-servicenow-default-url":"/api/now/scim/ServiceProviderConfig","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_serviceproviderconfig","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Users":{"get":{"operationId":"get_scim_get_scim_users","summary":"SCIM - GET /scim/Users","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported. For example, to filter for all users whose name starts with \"Jo\", enter userName SW \"jo\" (case-insensitive). To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all users whose name starts with \"Jo\" and whose last name contains \"smi\", enter userName SW \"john\" AND name.familyName CO \"smi\" . Use dot-walking to specify nested attributes. Only the following SCIM user fields are available for use in filters and some, as noted, only support fixed format: active addresses - Fixed format only, such as: [type eq \"home\" and streetAddress eq \"xxxx\"] [type eq \"home\" and locality eq \"xxxx\"] [type eq \"home\" and region eq \"xxxx\"] [type eq \"home\" and postalCode eq \"xxxx\"] [type eq \"home\" and country eq \"xxxx\"] displayName emails - Fixed format only, such as: [type eq \"work\" and value eq \"emailValue\"] externalId - Only EQ operator is supported. id meta.created meta.lastModified name.familyName name.givenName name.middleName preferredLanguage phoneNumbers - Fixed format only, such as: [type eq “work” and value eq “xxxx”] [type eq “mobile” and value eq “xxxx”] [type eq “home” and value eq “xxxx”] timezone title userName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:employeeNumber urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:gender urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.displayName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.value Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use the parameters available for filtering for the sortBy parameter, with the exception of externalId , which is not allowed. Also, only the following dot-walked parameters are supported: addressess - Only the following values are allowed: addresses.streetAddress - Maps to home street address. addresses.home.streetAddress addresses.locality - Maps to home locality. addresses.home.locality addresses.region - Maps to home region. addresses.home.region addresses.postalCode - Maps to home postal code. addresses.home.postalCode addresses.country - Maps to home country. addresses.home.country emails - Only the following values are allowed: emails.value - Maps to the email type work. emails.work.value phoneNumbers - Only the following values are allowed: phoneNumbers.value - Maps to the phone number type work. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value For values that are null: sorted by ascending - Null values are sorted to the top. sorted by descending - Null values are sorted to the bottom. Data type: String Default: No sort performed"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the User [sys_user] table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Not valid with the id path parameter. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Users","x-servicenow-default-url":"/api/now/scim/Users","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_users","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Users":{"get":{"operationId":"get_scim_get_scim_users__versioned_url","summary":"SCIM - GET /scim/Users","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimListResponse"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"count","in":"query","required":false,"schema":{"type":"string"},"description":"Number of records to return. A negative value is interpreted as zero. Data type: Number Maximum: 500 - A value greater than this results in a bad request error. Default: 10"},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Filter expression to apply to the return results. Field filters are expressed as <field_name> <operator> <\"value\"> . Refer to RFC7644 for a list of the valid operators. Note: The NOT operator is not supported. For example, to filter for all users whose name starts with \"Jo\", enter userName SW \"jo\" (case-insensitive). To specify more than one field filter, concatenate the filters using the AND operand. For example, to filter for all users whose name starts with \"Jo\" and whose last name contains \"smi\", enter userName SW \"john\" AND name.familyName CO \"smi\" . Use dot-walking to specify nested attributes. Only the following SCIM user fields are available for use in filters and some, as noted, only support fixed format: active addresses - Fixed format only, such as: [type eq \"home\" and streetAddress eq \"xxxx\"] [type eq \"home\" and locality eq \"xxxx\"] [type eq \"home\" and region eq \"xxxx\"] [type eq \"home\" and postalCode eq \"xxxx\"] [type eq \"home\" and country eq \"xxxx\"] displayName emails - Fixed format only, such as: [type eq \"work\" and value eq \"emailValue\"] externalId - Only EQ operator is supported. id meta.created meta.lastModified name.familyName name.givenName name.middleName preferredLanguage phoneNumbers - Fixed format only, such as: [type eq “work” and value eq “xxxx”] [type eq “mobile” and value eq “xxxx”] [type eq “home” and value eq “xxxx”] timezone title userName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:employeeNumber urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:gender urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:department.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.displayName urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:manager.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:costCenter.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:company.value urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.name urn:ietf:params:scim:schemas:extension:servicenow:2.0:User:location.value Data type: String Default: No filtering"},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortOrder parameter. Field by which to sort the return results. Sorting is case-insensitive. You can only use the parameters available for filtering for the sortBy parameter, with the exception of externalId , which is not allowed. Also, only the following dot-walked parameters are supported: addressess - Only the following values are allowed: addresses.streetAddress - Maps to home street address. addresses.home.streetAddress addresses.locality - Maps to home locality. addresses.home.locality addresses.region - Maps to home region. addresses.home.region addresses.postalCode - Maps to home postal code. addresses.home.postalCode addresses.country - Maps to home country. addresses.home.country emails - Only the following values are allowed: emails.value - Maps to the email type work. emails.work.value phoneNumbers - Only the following values are allowed: phoneNumbers.value - Maps to the phone number type work. phoneNumbers.home.value phoneNumbers.mobile.value phoneNumbers.work.value For values that are null: sorted by ascending - Null values are sorted to the top. sorted by descending - Null values are sorted to the bottom. Data type: String Default: No sort performed"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string"},"description":"Must be specified with the sortBy parameter. Order in which the sortBy parameter is applied to the return results. Valid values: ascending descending Data type: String Default: ascending"},{"name":"startIndex","in":"query","required":false,"schema":{"type":"string"},"description":"One-based index into the User [sys_user] table at which to start retrieving records. For example, if you set this parameter to 100, and the count parameter to 20, the endpoint returns records 100 through 119. Note: Any value that is set to less than one is interpreted as one. Not valid with the id path parameter. Data type: String Default: 1"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Users","x-servicenow-default-url":"/api/now/scim/Users","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_users","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/scim/Users/{user_id}":{"get":{"operationId":"get_scim_get_scim_users_user_id","summary":"SCIM - GET /scim/Users/{user_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Users/{user_id}","x-servicenow-default-url":"/api/now/scim/Users/{user_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_users_user_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/scim/Users/{user_id}":{"get":{"operationId":"get_scim_get_scim_users_user_id__versioned_url","summary":"SCIM - GET /scim/Users/{user_id}","tags":["System for Cross-domain Identity Management (SCIM) API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/scim+json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimResource"}}}},"400":{"description":"Bad Request. A bad request type or malformed request was detected. Ensure that both the attributes and excludedAttributes query parameters have not been passed in the request. Ensure that the count parameter is not greater than 500. Ensure that all filter parameters are valid."},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.ScimError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"user_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. No other fields are returned. Can't be used with the excludedAttributes parameter. Data type: String Default: Return all fields unless excludedAttributes is specified."},{"name":"excludedAttributes","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to exclude from the records returned in the response. All other fields are returned. Can't be used with the attributes parameter. Data type: String Default: Do not exclude any fields."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/scim/Users/{user_id}","x-servicenow-default-url":"/api/now/scim/Users/{user_id}","x-purplesuite-operation":{"vendorOperationId":"get_scim_get_scim_users_user_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/table/{tableName}":{"get":{"operationId":"get_table_get_now_table_tablename","summary":"Table - GET /now/table/{tableName}","tags":["Table API"],"responses":{"200":{"description":"Request completed successfully. If a valid query returned no results, the response body contains only an empty result array.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html","parameters":[{"name":"tableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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. Depending on the version, this endpoint returns different results on a valid query. Version 1 returns error code 404 with no results. Version 2 returns success code 200 and an empty array as the response body. Data type: String","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"name-value","in":"query","required":false,"schema":{"type":"string"},"description":"Name-value pairs to use to filter the result set. This parameter is mutually exclusive with sysparm_query . For example, instead of using &sysparm_query=active=true , you can simplify the calling statement by using &active=true . You can also use the display value when the field is a choice or reference type field, such as &state=closed instead of &state=7 . To specify multiple key-value pairs, separate each with an ampersand, such as &active=true&assigned_to=john.smith . Data type: String"},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user's time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record. Data type: String Valid values: true: Returns the display values for all fields. false: Returns the actual values from the database. all: Returns both actual and display values. Default: false Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905)."},{"name":"sysparm_exclude_reference_link","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to exclude Table API links for reference fields. Valid values: true: Exclude Table API links for reference fields. false: Include Table API links for reference fields. Data type: Boolean Default: false"},{"name":"sysparm_fields","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. Invalid fields are ignored. Data type: String Default: Return all fields."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sysparm_no_count","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to execute a select count(*) query on the table to return the number of rows in the associated table. Valid values: true: Do not execute a select count(*) . false: Execute a select count(*) . Data type: Boolean Default: false"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Don't pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. You can use a UI filter to obtain a properly encoded query. Syntax: sysparm_query=<col_name><operator><value> . Column names, operators, and values are case-sensitive. <col_name>: Name of the table column to filter on. <operator>: Supports the following values: = : <col_name> exactly matches <value>. != : <col_name> does not match <value>. LIKE : <col_name> contains the specified string <value>. Only works for <col_name> fields whose data type is string. STARTSWITH : <col_name> starts with the specified string <value>. Only works for <col_name> fields whose data type is string. ENDSWITH : <col_name> ends with the specified string <value>. Only works for <col_name> fields whose data type is string. ^ : AND operator to add an additional query condition. Records included in the result set match both conditions. ^OR : OR operator to add an additional query condition. Records included in the result set match at least one of the conditions. <value>: Value to filter on. For more information about operators, see Operators available for filters and queries . Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active. sysparm_query=caller_id=javascript:gs.getUserID()^active=true Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category. sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory By default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property glide.invalid_query.returns_no_rows to true to instead return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"sysparm_query_category","in":"query","required":false,"schema":{"type":"string"},"description":"Name of the category to use for queries. Data type: String"},{"name":"sysparm_query_no_domain","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured. Valid values: false: Exclude the record if it is in a domain that the currently logged in user is not configured to access. true: Include the record even if it is in a domain that the currently logged in user is not configured to access. Data type: Boolean Default: false Note: The sysparm_query_no_domain parameter is available only to system administrators or users who have the query_no_domain_table_api role."},{"name":"sysparm_suppress_pagination_header","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to remove the Link header from the response. The Link header provides various URLs to relative pages in the record set which you can use to paginate the returned record set. Valid values: true: Remove the Link header from the response. false: Do not remove the Link header from the response. Data type: Boolean Default: false"},{"name":"sysparm_view","in":"query","required":false,"schema":{"type":"string"},"description":"UI view for which to render the data. Determines the fields returned in the response. Valid values: desktop mobile both If you also specify the sysparm_fields parameter, it takes precedent. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/table/{tableName}","x-servicenow-default-url":"/api/now/table/{tableName}","x-purplesuite-operation":{"vendorOperationId":"get_table_get_now_table_tablename","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/table/{tableName}":{"get":{"operationId":"get_table_get_now_table_tablename__versioned_url","summary":"Table - GET /now/table/{tableName}","tags":["Table API"],"responses":{"200":{"description":"Request completed successfully. If a valid query returned no results, the response body contains only an empty result array.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordList"}}},"headers":{"X-Total-Count":{"description":"Total records matched by the query.","schema":{"type":"string"}},"Link":{"description":"Pagination URLs with rel values first, prev, next, and last.","schema":{"type":"string"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"tableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"name-value","in":"query","required":false,"schema":{"type":"string"},"description":"Name-value pairs to use to filter the result set. This parameter is mutually exclusive with sysparm_query . For example, instead of using &sysparm_query=active=true , you can simplify the calling statement by using &active=true . You can also use the display value when the field is a choice or reference type field, such as &state=closed instead of &state=7 . To specify multiple key-value pairs, separate each with an ampersand, such as &active=true&assigned_to=john.smith . Data type: String"},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user's time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record. Data type: String Valid values: true: Returns the display values for all fields. false: Returns the actual values from the database. all: Returns both actual and display values. Default: false Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905)."},{"name":"sysparm_exclude_reference_link","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to exclude Table API links for reference fields. Valid values: true: Exclude Table API links for reference fields. false: Include Table API links for reference fields. Data type: Boolean Default: false"},{"name":"sysparm_fields","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. Invalid fields are ignored. Data type: String Default: Return all fields."},{"name":"sysparm_limit","in":"query","required":false,"schema":{"type":"string"},"description":"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"},{"name":"sysparm_no_count","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to execute a select count(*) query on the table to return the number of rows in the associated table. Valid values: true: Do not execute a select count(*) . false: Execute a select count(*) . Data type: Boolean Default: false"},{"name":"sysparm_offset","in":"query","required":false,"schema":{"type":"string"},"description":"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. For example, the first time you call this endpoint, sysparm_offset is set to \"0\". To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit , until you reach the end of all records. Don't pass a negative number in the sysparm_offset parameter. Data type: Number Default: 0"},{"name":"sysparm_query","in":"query","required":false,"schema":{"type":"string"},"description":"Encoded query used to filter the result set. You can use a UI filter to obtain a properly encoded query. Syntax: sysparm_query=<col_name><operator><value> . Column names, operators, and values are case-sensitive. <col_name>: Name of the table column to filter on. <operator>: Supports the following values: = : <col_name> exactly matches <value>. != : <col_name> does not match <value>. LIKE : <col_name> contains the specified string <value>. Only works for <col_name> fields whose data type is string. STARTSWITH : <col_name> starts with the specified string <value>. Only works for <col_name> fields whose data type is string. ENDSWITH : <col_name> ends with the specified string <value>. Only works for <col_name> fields whose data type is string. ^ : AND operator to add an additional query condition. Records included in the result set match both conditions. ^OR : OR operator to add an additional query condition. Records included in the result set match at least one of the conditions. <value>: Value to filter on. For more information about operators, see Operators available for filters and queries . Queries can contain multiple conditions. For example, the following query returns records where the caller is the current user and the record is active. sysparm_query=caller_id=javascript:gs.getUserID()^active=true Encoded queries also support order by ascending and descending functionality. To sort responses based on certain fields, use the ORDERBY and ORDERBYDESC clauses in sysparm_query . Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> For example, the following query gets all active records and orders the results in ascending order by number, and then in descending order by category. sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory By default, if part of a query is invalid, such as an invalid field name, the instance ignores the invalid part. It then returns rows using only the valid portion of the query. Set the property glide.invalid_query.returns_no_rows to true to instead return no rows on an invalid query. Note: The glide.invalid_query.returns_no_rows property controls the behavior of all queries across the instance, such as in lists, scripts ( GlideRecord.query() ), and web service APIs. Data type: String"},{"name":"sysparm_query_category","in":"query","required":false,"schema":{"type":"string"},"description":"Name of the category to use for queries. Data type: String"},{"name":"sysparm_query_no_domain","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured. Valid values: false: Exclude the record if it is in a domain that the currently logged in user is not configured to access. true: Include the record even if it is in a domain that the currently logged in user is not configured to access. Data type: Boolean Default: false Note: The sysparm_query_no_domain parameter is available only to system administrators or users who have the query_no_domain_table_api role."},{"name":"sysparm_suppress_pagination_header","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to remove the Link header from the response. The Link header provides various URLs to relative pages in the record set which you can use to paginate the returned record set. Valid values: true: Remove the Link header from the response. false: Do not remove the Link header from the response. Data type: Boolean Default: false"},{"name":"sysparm_view","in":"query","required":false,"schema":{"type":"string"},"description":"UI view for which to render the data. Determines the fields returned in the response. Valid values: desktop mobile both If you also specify the sysparm_fields parameter, it takes precedent. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/table/{tableName}","x-servicenow-default-url":"/api/now/table/{tableName}","x-purplesuite-operation":{"vendorOperationId":"get_table_get_now_table_tablename","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/table/{tableName}/{sys_id}":{"get":{"operationId":"get_table_get_now_table_tablename_sys_id","summary":"Table - GET /now/table/{tableName}/{sys_id}","tags":["Table API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html","parameters":[{"name":"tableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user's time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record. Data type: String Valid values: true: Returns the display values for all fields. false: Returns the actual values from the database. all: Returns both actual and display values. Default: false Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905)."},{"name":"sysparm_exclude_reference_link","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to exclude Table API links for reference fields. Valid values: true: Exclude Table API links for reference fields. false: Include Table API links for reference fields. Data type: Boolean Default: false"},{"name":"sysparm_fields","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. Invalid fields are ignored. Data type: String Default: Return all fields."},{"name":"sysparm_query_no_domain","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured. Valid values: false: Exclude the record if it is in a domain that the currently logged in user is not configured to access. true: Include the record even if it is in a domain that the currently logged in user is not configured to access. Data type: Boolean Default: false Note: The sysparm_query_no_domain parameter is available only to system administrators or users who have the query_no_domain_table_api role."},{"name":"sysparm_view","in":"query","required":false,"schema":{"type":"string"},"description":"UI view for which to render the data. Determines the fields returned in the response. Valid values: desktop mobile both If you also specify the sysparm_fields parameter, it takes precedent. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/table/{tableName}/{sys_id}","x-servicenow-default-url":"/api/now/table/{tableName}/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_table_get_now_table_tablename_sys_id","classification":"modeled","urlForm":"default"}}},"/api/now/{api_version}/table/{tableName}/{sys_id}":{"get":{"operationId":"get_table_get_now_table_tablename_sys_id__versioned_url","summary":"Table - GET /now/table/{tableName}/{sys_id}","tags":["Table API"],"responses":{"200":{"description":"Successful. The request was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.TableRecordSingle"}}}},"401":{"description":"The user is not authorized to use the API.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"403":{"description":"The requested operation is not permitted for the user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}}},"404":{"description":"Not found. The requested item wasn't found."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"tableName","in":"path","required":true,"schema":{"type":"string"}},{"name":"sys_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"sysparm_display_value","in":"query","required":false,"schema":{"type":"string"},"description":"Determines the type of data returned, either the actual values from the database or the display values of the fields. Display values are manipulated based on the actual value in the database and user or system settings and preferences. If returning display values, the value that is returned is dependent on the field type. Choice fields: The database value may be a number, but the display value will be more descriptive. Date fields: The database value is in UTC format, while the display value is based on the user's time zone. Encrypted text: The database value is encrypted, while the displayed value is unencrypted based on the user's encryption context. Reference fields: The database value is sys_id, but the display value is a display field of the referenced record. Data type: String Valid values: true: Returns the display values for all fields. false: Returns the actual values from the database. all: Returns both actual and display values. Default: false Note: There is no preferred method for setting this parameter. However, specifying the display value may cause performance issues since it is not reading directly from the database and may include referencing other fields and records. For more information on display values and actual values, see Table API FAQs (KB0534905)."},{"name":"sysparm_exclude_reference_link","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to exclude Table API links for reference fields. Valid values: true: Exclude Table API links for reference fields. false: Include Table API links for reference fields. Data type: Boolean Default: false"},{"name":"sysparm_fields","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of fields to return in the response. Invalid fields are ignored. Data type: String Default: Return all fields."},{"name":"sysparm_query_no_domain","in":"query","required":false,"schema":{"type":"string"},"description":"Flag that indicates whether to restrict the record search to only the domains for which the logged in user is configured. Valid values: false: Exclude the record if it is in a domain that the currently logged in user is not configured to access. true: Include the record even if it is in a domain that the currently logged in user is not configured to access. Data type: Boolean Default: false Note: The sysparm_query_no_domain parameter is available only to system administrators or users who have the query_no_domain_table_api role."},{"name":"sysparm_view","in":"query","required":false,"schema":{"type":"string"},"description":"UI view for which to render the data. Determines the fields returned in the response. Valid values: desktop mobile both If you also specify the sysparm_fields parameter, it takes precedent. Data type: String"},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/table/{tableName}/{sys_id}","x-servicenow-default-url":"/api/now/table/{tableName}/{sys_id}","x-purplesuite-operation":{"vendorOperationId":"get_table_get_now_table_tablename_sys_id","classification":"modeled","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/wrapup/code/{code_id}":{"get":{"operationId":"get_wrap_up_get_now_wrapup_code_code_id","summary":"Wrap Up - GET /now/wrapup/code/{code_id}","tags":["Wrap Up API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the Interactions Management (com.glide.interaction.awa) plugin, the interaction_integration_user role, and the AWA interaction runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html","parameters":[{"name":"code_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/wrapup/code/{code_id}","x-servicenow-default-url":"/api/now/wrapup/code/{code_id}","x-purplesuite-operation":{"vendorOperationId":"get_wrap_up_get_now_wrapup_code_code_id","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/wrapup/code/{code_id}":{"get":{"operationId":"get_wrap_up_get_now_wrapup_code_code_id__versioned_url","summary":"Wrap Up - GET /now/wrapup/code/{code_id}","tags":["Wrap Up API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the Interactions Management (com.glide.interaction.awa) plugin, the interaction_integration_user role, and the AWA interaction runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"code_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/wrapup/code/{code_id}","x-servicenow-default-url":"/api/now/wrapup/code/{code_id}","x-purplesuite-operation":{"vendorOperationId":"get_wrap_up_get_now_wrapup_code_code_id","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}":{"get":{"operationId":"get_wrap_up_get_now_wrapup_segment_agent_agent_id_interaction_interaction_id","summary":"Wrap Up - GET /now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}","tags":["Wrap Up API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the Interactions Management (com.glide.interaction.awa) plugin, the interaction_integration_user role, and the AWA interaction runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"interaction_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}","x-servicenow-default-url":"/api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}","x-purplesuite-operation":{"vendorOperationId":"get_wrap_up_get_now_wrapup_segment_agent_agent_id_interaction_interaction_id","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}":{"get":{"operationId":"get_wrap_up_get_now_wrapup_segment_agent_agent_id_interaction_interaction_id__versioned_url","summary":"Wrap Up - GET /now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}","tags":["Wrap Up API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the Interactions Management (com.glide.interaction.awa) plugin, the interaction_integration_user role, and the AWA interaction runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"interaction_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}","x-servicenow-default-url":"/api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}","x-purplesuite-operation":{"vendorOperationId":"get_wrap_up_get_now_wrapup_segment_agent_agent_id_interaction_interaction_id","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}},"/api/now/wrapup/segment/{segment_id}":{"get":{"operationId":"get_wrap_up_get_now_wrapup_segment_segment_id","summary":"Wrap Up - GET /now/wrapup/segment/{segment_id}","tags":["Wrap Up API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the Interactions Management (com.glide.interaction.awa) plugin, the interaction_integration_user role, and the AWA interaction runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html","parameters":[{"name":"segment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"api_version","in":"query","required":false,"schema":{"type":"string"},"description":"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","x-purplesuite-note":"The pinned artifact declares api_version in the query string, which its own x-servicenow-versioned-url contradicts: the vendor carries the version as a path segment. This contract serves it as a path segment on the versioned URL form of this operation and ignores it here. The source declaration is kept rather than rewritten."},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/wrapup/segment/{segment_id}","x-servicenow-default-url":"/api/now/wrapup/segment/{segment_id}","x-purplesuite-operation":{"vendorOperationId":"get_wrap_up_get_now_wrapup_segment_segment_id","classification":"unavailable","urlForm":"default"}}},"/api/now/{api_version}/wrapup/segment/{segment_id}":{"get":{"operationId":"get_wrap_up_get_now_wrapup_segment_segment_id__versioned_url","summary":"Wrap Up - GET /now/wrapup/segment/{segment_id}","tags":["Wrap Up API"],"responses":{"200":{"description":"Successful. The request was successfully processed."},"400":{"description":"Bad Request. A bad request type or malformed request was detected."},"401":{"description":"Unauthorized. The user credentials are incorrect or have not been passed."},"403":{"description":"Not hosted by PurpleSuite. Requires the Interactions Management (com.glide.interaction.awa) plugin, the interaction_integration_user role, and the AWA interaction runtime. The documented meaning of 403 is that the requested operation is not permitted for the user, which is what an instance without this prerequisite returns.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/purplesuite.PlatformError"}}},"x-purplesuite-unavailable":{"axis":"entitlement + runtime","docs":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html"}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error."}},"x-docs-topic":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/wrap-up-api.html","parameters":[{"name":"api_version","in":"path","required":true,"schema":{"type":"string","enum":["v1","v2"]},"description":"Endpoint version. The difference is behavioural: on a valid query matching no records, v1 returns 404 with no results while v2 returns 200 and an empty array. Sourced from the pinned artifact's own api_version description."},{"name":"segment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"None","in":"query","required":false,"schema":{"type":"string"}}],"x-servicenow-versioned-url":"/api/now/{api_version}/wrapup/segment/{segment_id}","x-servicenow-default-url":"/api/now/wrapup/segment/{segment_id}","x-purplesuite-operation":{"vendorOperationId":"get_wrap_up_get_now_wrapup_segment_segment_id","classification":"unavailable","urlForm":"versioned","note":"Local operation id: the pinned artifact assigns one operationId to both URL forms, while OpenAPI requires unique ids and the painted-contract registry requires a route per document operation."}}}},"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"ServiceNow instance credentials as HTTP Basic. Simplest for testing; the user needs the roles the table/endpoint requires. See x-auth-source."},"oauth2":{"type":"oauth2","description":"ServiceNow OAuth 2.0. Register an application registry on the instance, then exchange credentials at `/oauth_token.do`. Preferred over Basic for production integrations. Scopes are instance-defined, so none are enumerated here. See x-auth-source.","flows":{"password":{"tokenUrl":"https://{instance}.service-now.com/oauth_token.do","scopes":{}},"clientCredentials":{"tokenUrl":"https://{instance}.service-now.com/oauth_token.do","scopes":{}}}}},"schemas":{"purplesuite.TableRecord":{"type":"object","description":"A table record. Columns depend on the table. Each value is a string when sysparm_display_value is false or true, an object carrying link/value for a reference field, or an object carrying display_value/value when sysparm_display_value=all.","additionalProperties":{"oneOf":[{"type":"string"},{"type":"object","properties":{"display_value":{"type":"string"},"value":{"type":"string"},"link":{"type":"string","format":"uri"}}}]},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html"},"purplesuite.TableRecordList":{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/purplesuite.TableRecord"}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html"},"purplesuite.TableRecordSingle":{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/purplesuite.TableRecord"}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_TableAPI.html"},"purplesuite.PlatformError":{"type":"object","required":["error","status"],"properties":{"error":{"type":"object","required":["message","detail"],"properties":{"message":{"type":"string","example":"No Record found"},"detail":{"type":"string","example":"Record doesn't exist or ACL restricts the record retrieval"}}},"status":{"type":"string","enum":["failure"]}},"description":"ServiceNow's platform error envelope. The status codes and their meanings are vendor-documented; the JSON envelope itself is not printed on any reference page and is corroborated from real instance responses. See COVERAGE_LEDGER.md.","x-purplesuite-response-source":"https://www.servicenow.com/docs/bundle/zurich-api-reference/page/integrate/inbound-rest/reference/r_RESTAPIHTTPResponseCodes.html"},"purplesuite.AggregateResult":{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"type":"object","properties":{"stats":{"type":"object","properties":{"count":{"type":"string"},"avg":{"type":"object","additionalProperties":{"type":"string"}},"min":{"type":"object","additionalProperties":{"type":"string"}},"max":{"type":"object","additionalProperties":{"type":"string"}},"sum":{"type":"object","additionalProperties":{"type":"string"}}}},"groupby_fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"display_value":{"type":"string"}}}}}}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AggregateAPI.html"},"purplesuite.AttachmentMetadata":{"type":"object","properties":{"sys_id":{"type":"string"},"file_name":{"type":"string"},"table_name":{"type":"string"},"table_sys_id":{"type":"string"},"content_type":{"type":"string"},"size_bytes":{"type":"string"},"size_compressed":{"type":"string"},"compressed":{"type":"string"},"download_link":{"type":"string","format":"uri"},"average_image_color":{"type":"string"},"image_width":{"type":"string"},"image_height":{"type":"string"},"hash":{"type":"string"},"sys_created_on":{"type":"string"},"sys_updated_on":{"type":"string"}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html"},"purplesuite.AttachmentList":{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/purplesuite.AttachmentMetadata"}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html"},"purplesuite.AttachmentSingle":{"type":"object","required":["result"],"properties":{"result":{"$ref":"#/components/schemas/purplesuite.AttachmentMetadata"}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_AttachmentAPI.html"},"purplesuite.CmdbInstance":{"type":"object","required":["result"],"properties":{"result":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/purplesuite.TableRecord"},"outbound_relations":{"type":"array","items":{"$ref":"#/components/schemas/purplesuite.CmdbRelation"}},"inbound_relations":{"type":"array","items":{"$ref":"#/components/schemas/purplesuite.CmdbRelation"}}}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html"},"purplesuite.CmdbRelation":{"type":"object","properties":{"sys_id":{"type":"string"},"type":{"$ref":"#/components/schemas/purplesuite.CmdbReference"},"target":{"$ref":"#/components/schemas/purplesuite.CmdbReference"}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html"},"purplesuite.CmdbReference":{"type":"object","properties":{"display_value":{"type":"string"},"link":{"type":"string"},"value":{"type":"string"}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-instance-api.html"},"purplesuite.CmdbMeta":{"type":"object","required":["result"],"properties":{"result":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"parent":{"type":"string"},"icon":{"type":"string"},"icon_url":{"type":"string"},"is_extendable":{"type":"string"},"children":{"type":"array","items":{"type":"string"}},"attributes":{"type":"array","items":{"type":"object","properties":{"element":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"max_length":{"type":"string"},"is_inherited":{"type":"string"},"is_mandatory":{"type":"string"},"is_display":{"type":"string"},"reference":{"type":"string"},"read_only":{"type":"string"}}}},"relationship_rules":{"type":"array","items":{"type":"object","properties":{"parent":{"type":"string"},"child":{"type":"string"},"relation_type":{"type":"string"}}}},"identification_rules":{"type":"object","properties":{"applies_to":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object"}},"related_rules":{"type":"array","items":{"type":"object"}}}}}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/cmdb-meta-api.html"},"purplesuite.ImportSetResult":{"type":"object","description":"The Import Set API is the one in-scope operation whose envelope is not solely `result`: `import_set` and `staging_table` are siblings of it.","required":["import_set","staging_table","result"],"properties":{"import_set":{"type":"string","example":"ISET0010001"},"staging_table":{"type":"string","example":"imp_user"},"result":{"type":"array","items":{"type":"object","properties":{"transform_map":{"type":"string"},"table":{"type":"string"},"display_name":{"type":"string"},"display_value":{"type":"string"},"record_link":{"type":"string","format":"uri"},"status":{"type":"string"},"sys_id":{"type":"string"}}}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/c_ImportSetAPI.html"},"purplesuite.DataClasses":{"type":"object","required":["result"],"properties":{"result":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"parent":{"type":"string"},"sys_id":{"type":"string"}}}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/data-classification-api.html"},"purplesuite.CiLifecycleBoolean":{"type":"object","description":"These operations document `result` as a bare boolean, not an object.","required":["result"],"properties":{"result":{"type":"boolean"}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html"},"purplesuite.CiLifecycleResult":{"type":"object","required":["result"],"properties":{"result":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object"}},"result":{"type":"string"},"operationalState":{"type":"string"},"ciActions":{"type":"array","items":{"type":"string"}}}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/ci-lifecycle-management-api.html"},"purplesuite.ScimListResponse":{"type":"object","required":["schemas","totalResults","Resources"],"properties":{"schemas":{"type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]},"totalResults":{"type":"integer"},"startIndex":{"type":"integer"},"itemsPerPage":{"type":"integer"},"Resources":{"type":"array","items":{"type":"object"}}},"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html"},"purplesuite.ScimResource":{"type":"object","required":["schemas","id"],"properties":{"schemas":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"displayName":{"type":"string"},"meta":{"type":"object","properties":{"resourceType":{"type":"string"},"created":{"type":"string"},"lastModified":{"type":"string"},"location":{"type":"string"},"version":{"type":"string"}}}},"additionalProperties":true,"x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html"},"purplesuite.ScimError":{"type":"object","required":["errors"],"properties":{"errors":{"type":"object","properties":{"details":{"type":"string"},"schemas":{"type":"string"},"scimType":{"type":"string"},"status":{"type":"string"}}}},"description":"SCIM's error envelope is plural `errors` and has no `status: \"failure\"` sibling. It is not interchangeable with purplesuite.PlatformError.","x-purplesuite-response-source":"https://www.servicenow.com/docs/r/zurich/api-reference/rest-apis/scim-api.html"}}},"security":[{"basicAuth":[]},{"oauth2":[]}],"tags":[{"name":"AWA Agent API"},{"name":"Account API"},{"name":"ActivitySubscriptions API"},{"name":"Aggregate API"},{"name":"Application Service API"},{"name":"Attachment API"},{"name":"CI Lifecycle Management API"},{"name":"CMDB Instance API"},{"name":"CMDB Meta API"},{"name":"CSM Attachment API"},{"name":"Cloud Runner Test Generation REST API"},{"name":"Cloud Runner Test Runner REST API"},{"name":"Cloud Runner Test User REST API"},{"name":"Cloud Services Catalog API"},{"name":"Consumer API"},{"name":"Contact API"},{"name":"Data Classification API"},{"name":"Email API"},{"name":"Import Set API"},{"name":"MetricBase Time Series API"},{"name":"Predictive Intelligence API"},{"name":"Scorecards API"},{"name":"Script Debugger API"},{"name":"System for Cross-domain Identity Management (SCIM) API"},{"name":"Table API"},{"name":"Wrap Up API"}],"x-scraped":{"source":"https://www.servicenow.com/docs","khub_maps":"https://www.servicenow.com/docs/api/khub/maps","release":"zurich","generator":"scripts/scrape_servicenow_docs.py","provenance":"scraped","topics_fetched":122,"topics_failed":0,"operations":577,"headings_unparsed":54,"collisions":3,"with_versioned_url":432,"reliable":["method and path (explicit <h2> markup)","versioned and default URL forms (declared <p> markup)","query parameter names and descriptions (declared tables)","status codes (declared tables)"],"not_derived":["response schemas - documented as prose 'Response body parameters' tables, not as typed schemas; synthesising types from prose would invent information","request body schemas - same reason","parameter types - everything is typed string"]},"x-catalog-notice":{"defect":"22 path keys are not valid URL templates, in three distinct shapes: 17 embed the HTTP method as text in the route, 3 contain a stray space, and 2 carry a documentation label instead of a route.","vendor_declares":"the 17 verb-embedded keys read like '/PATCH /api/sn_tmf_api/appointment/appointment/{id}', '/POST /api/sn_cdm/applications/uploads/collections/file' and '/GET /api/now/sn_atf_tg/test_generation_progress'; two of those are additionally malformed, since '/POST api/now/sn_atf_tg/test_runner' has no leading slash after the verb and '/GET /now/sn_atf_tg/cancel_test_runner' is missing the '/api' segment. The 3 stray-space keys are '/api/sn_cicd/update_set/ commit/{remote_update_set_id}', '/api/sn_sc/ servicecatalog/items/{sys_id}/add_to_wishlist' and '/api/sn_tmf_api/catalogmanagement/serviceCategory/ {id}'. The 2 label keys are '/Versioned URL: /api/now/{api_version}/email' and '/Versioned URL: /api/now/{api_version}/email/{id}', where the scrape captured a caption from the docs page as though it were the route.","actually_required":"for the verb-embedded keys, the route alone with the verb expressed as the method key — '/api/sn_tmf_api/appointment/appointment/{id}' under a `patch:` key. For the stray-space keys, the same route with the space removed. For the two label keys, the route that follows the caption. Every shape is an artifact of deriving this file from scraped documentation, where the verb, the caption and the line wrapping all sit next to the path in the page's markup.","consequence":"all 22 routes are uncallable as written — a request would target a percent-encoded path beginning '/PATCH%20/api/...' and 404. The method key on each of these operations is separately correct, so the verb is also duplicated.","catalogue_wide":"this file is tagged 'scraped'. It is the only file in the catalogue where the derivation captured the verb into the route; the same scrape family (coupa, freshservice, workato, netsuite) shows different artifacts.","vendor_reference":"https://developer.servicenow.com/dev.do#!/reference/api","disposition":"REPORTED, NOT REPAIRED. This is what the vendor publishes at the Source URL. Substituting a value here would replace vendor content with our inference and hide which parts the vendor wrote. Override it in the consumer, using actually_required above.","verified_against_source":false,"verification_note":"derived from the committed document on 2026-09-08. The vendor URL was NOT re-fetched in this pass, so every value under vendor_declares is quoted from this file rather than confirmed live against the vendor. Re-fetch before relying on actually_required."}}