ServiceNowClient
Classes
GetAttachmentMetdataResponse
dataclass
UploadAttachmentResponse
dataclass
RetrieveAttachmentMetadataResponse
dataclass
GetRecordsResponse
dataclass
Response for List Records
SingleRecordResponse
dataclass
Response for Create Record
GetTypesResponse
dataclass
GetCatalogsResponse
dataclass
Response for Get catalogs
GetCatalogCategoriesResponse
dataclass
Response for Get catalog categories
GetCatalogItemsResponse
dataclass
Response for Get catalog items
GetCatalogItemResponse
dataclass
Response for Get catalog item
OrderItemInput
dataclass
OrderItemInput(sysparm_quantity: int, *, sysparm_requested_for: Optional[str] = None, variables: Optional[Dict[str, Any]] = None)
Order item
Attributes
sysparm_requested_for
class-attribute
instance-attribute
User for which the item is ordered for.
OrderItemResponse
dataclass
GetArticlesResponse
dataclass
GetArticlesResponse(*, meta: Optional[Dict[str, Any]] = None, articles: Optional[List[Dict[str, Any]]] = None)
Response for Get Knowledge Articles
GetArticleResponse
dataclass
GetRecordSchemaResponse
dataclass
Response for Get Record Schema
GetCurrentUserInfoResponse
dataclass
GetStatsResponse
dataclass
Definition: GetStatsResponse
RecordBody
dataclass
ServiceNowClient
ServiceNowClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for service-now connector.
Initialize a ServiceNowClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
get_attachment_metdata
async
get_attachment_metdata(*, sysparm_limit: Optional[str] = None, sysparm_offset: Optional[str] = None, sysparm_query: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Attachment Metadata
Retrieve metadata for attachments
Swagger operation ID: GetAttachmentMetdata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sysparm_limit
|
Optional[str]
|
Limit to be applied on pagination. Note: Unusually large sysparm_limit values can impact system performance. Default: 1000. |
None
|
sysparm_offset
|
Optional[str]
|
Number of records to exclude from the query. Use this parameter to get more records than specified in sysparm_limit. For example, if sysparm_limit is set to 500, but there are additional records you want to query, you can specify a sysparm_offset value of 500 to get the second set of records. Default: 0. |
None
|
sysparm_query
|
Optional[str]
|
Encoded query. Queries for the Attachment API are relative to the Attachments [sys_attachment] table. For example: (sysparm_query=file_name=attachment.doc). |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
upload_attachment_file
async
upload_attachment_file(input: bytes, table_name: str, table_sys_id: str, file_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Upload a binary file as an attachment
Uploads a binary file as an attachment to a specified record
Swagger operation ID: UploadAttachmentFile.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
bytes
|
The binary request body. |
required |
table_name
|
str
|
Name of the table to which you want to attach the file. |
required |
table_sys_id
|
str
|
Sys_id of the record on the specified table to which you want to attach the file. |
required |
file_name
|
str
|
Name to give the attachment. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
upload_attachment
async
upload_attachment(attachment_content: MultipartFile | bytes, table_name: str, table_sys_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Upload a multipart file attachment
Upload an attachment from a multipart form
Swagger operation ID: UploadAttachment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
attachment_content
|
MultipartFile | bytes
|
Attachment to upload. |
required |
table_name
|
str
|
Name of the table to which you want to attach the file. |
required |
table_sys_id
|
str
|
Sys_id of the record on the specified table to which you want to attach the file. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
retrieve_attachment_metadata
async
retrieve_attachment_metadata(sys_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Retrieve attachment metadata
Retrieve attachment metadata
Swagger operation ID: RetrieveAttachmentMetadata.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sys_id
|
str
|
Sys_id of the attachment to retrieve metadata for. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
delete_attachment
async
delete_attachment(sys_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete an attachment
Delete an attachment
Swagger operation ID: DeleteAttachment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sys_id
|
str
|
Sys_id of the attachment to delete. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
retrieve_attachment_content
async
retrieve_attachment_content(sys_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes
Retrieve attachment content
Retrieve attachment content
Swagger operation ID: RetrieveAttachmentContent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sys_id
|
str
|
Sys_id of the attachment to retrieve content for. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
bytes |
bytes
|
The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_records
list_records(table_type: str, *, sysparm_display_value: Optional[bool] = None, sysparm_exclude_reference_link: Optional[bool] = None, sysparm_query: Optional[str] = None, sysparm_limit: Optional[int] = None, sysparm_offset: Optional[int] = None, sysparm_fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List Records
Gets records of a certain ServiceNow object type like 'Incidents'
Returns a single-page Azure Core async collection.
Swagger operation ID: GetRecords.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
table_type
|
str
|
Type of record to list. |
required |
sysparm_display_value
|
Optional[bool]
|
Determines if system references should be included. |
None
|
sysparm_exclude_reference_link
|
Optional[bool]
|
Determines if reference links should be excluded. |
None
|
sysparm_query
|
Optional[str]
|
Encoded query used to filter the result set. Example: active=true^ORDERBYnumber^ORDERBYDESCcategory. |
None
|
sysparm_limit
|
Optional[int]
|
Limit to be applied on pagination. The default is 10000. |
None
|
sysparm_offset
|
Optional[int]
|
Number of records to exclude from the query. |
None
|
sysparm_fields
|
Optional[str]
|
Comma-separated list of fields to be returned. Example: name,email,phone. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
create_record
async
create_record(input: RecordBody | Mapping[str, Any], table_type: str, *, sysparm_display_value: Optional[bool] = None, sysparm_input_display_value: Optional[bool] = None, sysparm_exclude_reference_link: Optional[bool] = None, sysparm_fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Record
Create a record in a ServiceNow table.
Swagger operation ID: CreateRecord.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RecordBody | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
table_type
|
str
|
Type of record to list. |
required |
sysparm_display_value
|
Optional[bool]
|
Determines if system references should be included. |
None
|
sysparm_input_display_value
|
Optional[bool]
|
Determines if input values are treated as display values (true) or raw/internal values (false). When true, the API interprets field values in the request body as display values (e.g., 'Resolved' for state) and maps them to internal values. |
None
|
sysparm_exclude_reference_link
|
Optional[bool]
|
Determines if reference links should be excluded. |
None
|
sysparm_fields
|
Optional[str]
|
Comma-separated list of fields to be returned. Example: name,email,phone. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_record
async
get_record(table_type: str, sysid: str, *, sysparm_display_value: Optional[bool] = None, sysparm_exclude_reference_link: Optional[bool] = None, sysparm_fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Record
Gets a record for a ServiceNow object type like 'Incidents'
Swagger operation ID: GetRecord.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
table_type
|
str
|
Type of record to list. |
required |
sysid
|
str
|
System ID for the record. |
required |
sysparm_display_value
|
Optional[bool]
|
Determines if system references should be included. |
None
|
sysparm_exclude_reference_link
|
Optional[bool]
|
Determines if reference links should be excluded. |
None
|
sysparm_fields
|
Optional[str]
|
Comma-separated list of fields to be returned. Example: name,email,phone. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_record
async
update_record(input: RecordBody | Mapping[str, Any], table_type: str, sysid: str, *, sysparm_display_value: Optional[bool] = None, sysparm_input_display_value: Optional[bool] = None, sysparm_exclude_reference_link: Optional[bool] = None, sysparm_fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Record
Updates a record for a ServiceNow object type like 'Incidents'
Swagger operation ID: UpdateRecord.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RecordBody | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
table_type
|
str
|
Type of record to list. |
required |
sysid
|
str
|
System ID for the record. |
required |
sysparm_display_value
|
Optional[bool]
|
Determines if system references should be included. |
None
|
sysparm_input_display_value
|
Optional[bool]
|
Determines if input values are treated as display values (true) or raw/internal values (false). When true, the API interprets field values in the request body as display values (e.g., 'Resolved' for state) and maps them to internal values. |
None
|
sysparm_exclude_reference_link
|
Optional[bool]
|
Determines if reference links should be excluded. |
None
|
sysparm_fields
|
Optional[str]
|
Comma-separated list of fields to be returned. Example: name,email,phone. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
delete_record
async
delete_record(table_type: str, sysid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete Record
Deletes a record for a ServiceNow object type like 'Incidents
Swagger operation ID: DeleteRecord.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
table_type
|
str
|
Type of record to list. |
required |
sysid
|
str
|
System ID for the record. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_record_types
list_record_types(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Record Types
Lists the available record types
Returns a single-page Azure Core async collection.
Swagger operation ID: GetRecordTypes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_catalogs
list_catalogs(*, sysparm_limit: Optional[int] = None, sysparm_text: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get catalogs
Retrieves a list of catalogs
Returns a single-page Azure Core async collection.
Swagger operation ID: GetCatalogs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sysparm_limit
|
Optional[int]
|
Number of catalogs to retrieve. |
None
|
sysparm_text
|
Optional[str]
|
Search text to filter catalogs by name or description. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_catalog_categories
list_catalog_categories(catalog_id: str, *, sysparm_limit: Optional[int] = None, sysparm_offset: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get catalog categories
Retrieves list of categories for a specific catalog
Returns a single-page Azure Core async collection.
Swagger operation ID: GetCatalogCategories.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
catalog_id
|
str
|
The id of the catalog for which to retrieve categories. |
required |
sysparm_limit
|
Optional[int]
|
Number of catalog categories to retrieve. |
None
|
sysparm_offset
|
Optional[int]
|
Offset for the query. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_catalog_items
list_catalog_items(sysparm_limit: int, *, sysparm_category: Optional[str] = None, sysparm_text: Optional[str] = None, sysparm_catalog: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get catalog items
Retrieves a list of catalog items based on the specified parameters, like a search text or a catalog.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetCatalogItems.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sysparm_limit
|
int
|
Number of catalog items to retrieve. |
required |
sysparm_category
|
Optional[str]
|
The category ID to filter items by. If not specified, all items are returned. |
None
|
sysparm_text
|
Optional[str]
|
Search text to filter items by. |
None
|
sysparm_catalog
|
Optional[str]
|
The catalog ID to filter items by. If not specified, items from all catalogs are returned. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_catalog_item
async
get_catalog_item(sys_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get catalog item
Retrieve a specific catalog item.
Swagger operation ID: GetCatalogItem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
sys_id
|
str
|
The sys_id of the catalog item to retrieve. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
order_item
async
order_item(input: OrderItemInput | Mapping[str, Any], sys_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Order item
Orders or buys a specific catalog item.
Swagger operation ID: OrderItem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
OrderItemInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
sys_id
|
str
|
The sys_id of the catalog item to order. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_knowledge_articles
list_knowledge_articles(query: str, *, fields: Optional[str] = None, limit: Optional[int] = None, filter: Optional[str] = None, kb: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Knowledge Articles
Returns a list of knowledge base (KB) articles which can be searched and filtered
Returns a single-page Azure Core async collection.
Swagger operation ID: GetKnowledgeArticles.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
query
|
str
|
Text to search for. |
required |
fields
|
Optional[str]
|
Comma-separated list of fields from the Knowledge table. |
None
|
limit
|
Optional[int]
|
Maximum number of records to return. |
None
|
filter
|
Optional[str]
|
Encoded query to use to filter the result set. |
None
|
kb
|
Optional[str]
|
Comma-separated list of knowledge base sys_ids. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_knowledge_article
async
get_knowledge_article(article_sys_id: str, *, fields: Optional[str] = None, language: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Knowledge Article
Returns the full content of a single knowledge base (KB) article, including template/Knowledge-Block section content that is not returned by the Get Knowledge Articles search endpoint.
Swagger operation ID: GetKnowledgeArticle.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
article_sys_id
|
str
|
The sys_id or KB number of the knowledge article to retrieve. |
required |
fields
|
Optional[str]
|
Comma-separated list of fields from the Knowledge table to return. |
None
|
language
|
Optional[str]
|
Comma-separated list of languages of the KB article to return. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_record_schema
async
get_record_schema(table_type: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Record Schema
Gets the schema of a record type
Swagger operation ID: GetRecordSchema.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
table_type
|
str
|
Type of record to list. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |