API Reference

Search admin data jobs

get
https://{host}/platform/admindata/v1/jobs

Returns list of admin data jobs.

Admin Data API jobs include the ARCHIVE_EDM, ARCHIVE_SECURABLE, COPY_TO_ARCHIVE, DELETE_ARCHIVE, and RESTORE_ARCHIVE jobs.

To learn more about managing and tracking jobs, see Platform Jobs.

🍐

Permissions

To perform this operation, a principal must belong to a group that has been assigned the Data Admin role.

To learn more about role-based permissions in Risk Modeler, see Access Controls.

Query Params
string

Query string to select response data based on property values. Supported properties: endedAt, jobId, name, startedAt, status, type, userName Depending on the property, you may use comparison operators, list operators, and logical operators.

PropertyData TypeComparisonList
endedAtYYY-MM-DD=
jobIdstring=IN
namestring=
startedAtYYY-MM-DD=
statusstring=
typestring=
userNamestring=

See Filtering Responses.

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: endedAt, jobId, name, startedAt, status, type

int32

Number of records to display per page.

int32

Number of the page displaying the returned records, starting at 0.

Responses

Updated 6 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago