Skip to main content

​
Submodules

​
Module contents

This module provides access to the compliance endpoints of the X API and serves as the main entry point for all compliance-related functionality.

​
class xdk.compliance.ComplianceClient

Client for compliance operations

​
Parameters

​
path.client
Client

​
__init__

​
Parameters

​
path.client
Client

​
create_jobs

Create Compliance Job Creates a new Compliance Job for the specified job type. body: Request body :returns: Response data :rtype: CreateJobsResponse

​
Parameters

​
body.body
CreateJobsRequest

​
get_jobs

Get Compliance Jobs Retrieves a list of Compliance Jobs filtered by job type and optional status.

​
Parameters

​
path.type
str
Type of Compliance Job to list.
​
path.status
str or None
default:"None"
Status of Compliance Job to list.
​
path.compliance_job_fields
List or None
default:"None"
A comma separated list of ComplianceJob fields to display.

​
Returns

GetJobsResponse - Response data

​
get_jobs_by_id

Get Compliance Job by ID Retrieves details of a specific Compliance Job by its ID.

​
Parameters

​
path.id
Any
The ID of the Compliance Job to retrieve.
​
path.compliance_job_fields
List or None
default:"None"
A comma separated list of ComplianceJob fields to display.

​
Returns

GetJobsByIdResponse - Response data