GraphQLRepositoriesprocessActivityLog
entities.processActivityLog
Read process activity log records with the processActivityLog repository, and change them with the process activity log mutations. Same records as the REST ProcessActivityLogs entity.
Queries
Fields of entities { processActivityLog { … } }.
| Kind | Field | Returns |
|---|---|---|
| QUERY | getById(entityId: ID!)Returns the record with the given id, or null when there is none. Deleted records are returned as well. | ProcessActivityLogEntity |
| QUERY | getByIds(entityIds: [ID!]!)Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. | [ProcessActivityLogEntity!]! |
| QUERY | getAll(limit: Int, offset: Int, filter: ProcessActivityLogFilterInput, orderBy: [ProcessActivityLogOrderByInput!], includeDeleted: Boolean)Returns the records that match the filter, paged with limit and offset. | [ProcessActivityLogEntity!]! |
| QUERY | getByCriteria(filter: ProcessActivityLogFilterInput, orderBy: [ProcessActivityLogOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)Returns the records that match the filter as a cursor-paginated connection. | ProcessActivityLogEntityConnection |
| QUERY | getChangedFieldsSinceRevision(id: UUID!, revision: Int!)Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. | [UUID!]! |
| QUERY | getDownloadUrl(processId: UUID!, name: String!, filter: ProcessActivityLogFilterInput, days: Int)Exports the activity log of a process to a zipped text file and returns a URL to download it. | String! |
Mutations
| Kind | Mutation | Does | Returns |
|---|---|---|---|
| MUTATION | createProcessActivityLog(input: CreateProcessActivityLogInput!, validationLevel: [ValidationLevel!]) | Create one record | CreateProcessActivityLogPayload |
| MUTATION | updateProcessActivityLog(input: UpdateProcessActivityLogInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String) | Update fields | UpdateProcessActivityLogPayload |
| MUTATION | bulkUpdateProcessActivityLog(input: [CreateOrUpdateProcessActivityLogInput!]!, deleteInput: [DeleteProcessActivityLogInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput) | Create or update many; per-item results | BulkUpdateProcessActivityLogPayload |
| MUTATION | deleteProcessActivityLog(input: DeleteProcessActivityLogInput!) | Soft-delete | DeleteProcessActivityLogPayload |
Types
The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.
ProcessActivityLogEntity object 21 fields: isDeleteProtected, id, isDeleted, …
One run of an Automatizer process, with its status, timing and the steps it took.
| Field | Type | Description |
|---|---|---|
isDeleteProtected | Boolean! | True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. |
id | ID! | Unique identifier of entity. |
isDeleted | Boolean | Specifies if the entity is considered deleted. |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
actor | ClientEntity | User who triggered the run, or empty for runs triggered by automation. |
application | ApplicationEntity | Application context the run was triggered in. |
process | ProcessEntity | Process whose execution this log records. |
actorId | ID | Id of the user who triggered the run, or empty for runs triggered by automation. |
applicationId | ID! | Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. |
cpuRunTime | Float | Total CPU time consumed by the run, in seconds. |
endTime | DateTime | Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). |
isTestRun | Boolean | True when the run was triggered as a test (results are not persisted to records). |
parentProcessIds | JSONString | Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. |
processId | ID! | Id of the Automatizer process whose run this log records. |
runId | ID | Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. |
startTime | DateTime! | Timestamp the run started. |
status | ProcessStatusEnum! | Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. |
lines | ProcessActivityLogLineEntityConnection (7 args) | Activity log lines describing each step taken in this run (visible only). |
recordName | String | Name of the trigger record (extracted from the first log line) for display in activity log lists. |
instancePermissions | [EntityPermsEnum!]! (1 args) | Permissions the current user has on this record, out of the requested ones. |
ProcessActivityLogEntityConnection object pageInfo: PageInfo!, edges: [ProcessActivityLogEntityEdge]!, totalCount: Int
Paginated list of ProcessActivityLog records.
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo! | Pagination data for this connection. |
edges | [ProcessActivityLogEntityEdge]! | Contains the nodes in this connection. |
totalCount | Int | Total number of items in the connection. |
ProcessActivityLogEntityEdge object node: ProcessActivityLogEntity, cursor: String!
A Relay edge containing a ProcessActivityLogEntity and its cursor.
| Field | Type | Description |
|---|---|---|
node | ProcessActivityLogEntity | The item at the end of the edge |
cursor | String! | A cursor for use in pagination |
ProcessActivityLogFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field
Filter conditions for ProcessActivityLog records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.
| Input field | Type | Description |
|---|---|---|
OR | [ProcessActivityLogFilterInput!] | Matches records that meet at least one of the listed filters. |
AND | [ProcessActivityLogFilterInput!] | Matches records that meet all of the listed filters. |
NOT | ProcessActivityLogFilterInput | Matches records that do not meet this filter. |
globalSearchQuery | String | Search term matched against the fields that the global search covers for this entity. |
id | EntityFilterStringField | Unique identifier of entity. |
isDeleted | Boolean | Specifies if the entity is considered deleted. |
modified | EntityFilterDateTimeField | Last modification time. |
created | EntityFilterDateTimeField | Creation time. |
actorId | EntityFilterStringField | Id of the user who triggered the run, or empty for runs triggered by automation. |
applicationId | EntityFilterStringField | Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. |
cpuRunTime | EntityFilterNumberField | Total CPU time consumed by the run, in seconds. |
endTime | EntityFilterDateTimeField | Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). |
isTestRun | Boolean | True when the run was triggered as a test (results are not persisted to records). |
processId | EntityFilterStringField | Id of the Automatizer process whose run this log records. |
runId | EntityFilterStringField | Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. |
startTime | EntityFilterDateTimeField | Timestamp the run started. |
status | ProcessStatusEnumFilterInput | Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. |
recordName | String | Name of the trigger record (extracted from the first log line) for display in activity log lists. |
actor | ClientFilterInput | User who triggered the run, or empty for runs triggered by automation. Matches records where a related record meets these conditions. |
application | ApplicationFilterInput | Application context the run was triggered in. Matches records where a related record meets these conditions. |
process | ProcessFilterInput | Process whose execution this log records. Matches records where a related record meets these conditions. |
lines | ProcessActivityLogLineFilterInput | Activity log lines describing each step taken in this run (visible only). Matches records where a related record meets these conditions. |
ProcessActivityLogOrderByInput input Asc or Desc per field
Sorting of ProcessActivityLog records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.
| Input field | Type | Description |
|---|---|---|
id | OrderByEnum | Unique identifier of entity. |
isDeleted | OrderByEnum | Specifies if the entity is considered deleted. |
modified | OrderByEnum | Last modification time. |
created | OrderByEnum | Creation time. |
actor | [ClientOrderByNestedInput!] | User who triggered the run, or empty for runs triggered by automation. Sorts by fields of the related record, listed in order of priority. |
application | [ApplicationOrderByNestedInput!] | Application context the run was triggered in. Sorts by fields of the related record, listed in order of priority. |
process | [ProcessOrderByNestedInput!] | Process whose execution this log records. Sorts by fields of the related record, listed in order of priority. |
actorId | OrderByEnum | Id of the user who triggered the run, or empty for runs triggered by automation. |
applicationId | OrderByEnum | Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. |
cpuRunTime | OrderByEnum | Total CPU time consumed by the run, in seconds. |
endTime | OrderByEnum | Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). |
isTestRun | OrderByEnum | True when the run was triggered as a test (results are not persisted to records). |
processId | OrderByEnum | Id of the Automatizer process whose run this log records. |
startTime | OrderByEnum | Timestamp the run started. |
status | OrderByEnum | Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. |
recordName | OrderByEnum | Name of the trigger record (extracted from the first log line) for display in activity log lists. |
CreateOrUpdateProcessActivityLogInput input 14 fields: clientMutationId, id, modified, …
Field values of a ProcessActivityLog record to create, or to update when its id is set.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
id | ID | Unique identifier of entity. |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
actorId | ID | Id of the user who triggered the run, or empty for runs triggered by automation. |
applicationId | ID | Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. |
cpuRunTime | Float | Total CPU time consumed by the run, in seconds. |
endTime | DateTime | Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). |
isTestRun | Boolean | True when the run was triggered as a test (results are not persisted to records). |
parentProcessIds | JSONString | Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. |
processId | ID | Id of the Automatizer process whose run this log records. |
runId | ID | Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. |
startTime | DateTime | Timestamp the run started. |
status | ProcessStatusEnum | Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. |
CreateProcessActivityLogInput input 13 fields: clientMutationId, modified, created, …
Field values of a new ProcessActivityLog record.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
actorId | ID | Id of the user who triggered the run, or empty for runs triggered by automation. |
applicationId | ID! | Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. |
cpuRunTime | Float | Total CPU time consumed by the run, in seconds. |
endTime | DateTime | Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). |
isTestRun | Boolean | True when the run was triggered as a test (results are not persisted to records). |
parentProcessIds | JSONString | Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. |
processId | ID! | Id of the Automatizer process whose run this log records. |
runId | ID | Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. |
startTime | DateTime! | Timestamp the run started. |
status | ProcessStatusEnum! | Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. |
DeleteProcessActivityLogInput input clientMutationId: String, id: ID!
Id of the ProcessActivityLog record to delete.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
id | ID! | Unique identifier of entity. |
UpdateProcessActivityLogInput input 14 fields: clientMutationId, id, modified, …
Id of a ProcessActivityLog record and the field values to change.
| Input field | Type | Description |
|---|---|---|
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
id | ID! | Unique identifier of entity. |
modified | DateTime | Last modification time. |
created | DateTime | Creation time. |
actorId | ID | Id of the user who triggered the run, or empty for runs triggered by automation. |
applicationId | ID | Id of the application the triggering change came from, such as the web app or an API access; scheduled runs are attributed to the Automatizer. |
cpuRunTime | Float | Total CPU time consumed by the run, in seconds. |
endTime | DateTime | Timestamp the run finished. Empty while the run is still in progress (e.g. waiting on scheduled actions). |
isTestRun | Boolean | True when the run was triggered as a test (results are not persisted to records). |
parentProcessIds | JSONString | Ids of parent processes that triggered this run, ordered from outermost to innermost. Empty for top-level runs. |
processId | ID | Id of the Automatizer process whose run this log records. |
runId | ID | Identifier grouping all activity logs that share the same root process run, including chained sub-process runs. |
startTime | DateTime | Timestamp the run started. |
status | ProcessStatusEnum | Overall result of the process run: the most severe status among its log lines, Error when any step failed and Warning when a step completed with warnings. |
BulkUpdateProcessActivityLogPayload object result: BulkUpdateResults!
Result of the bulkUpdateProcessActivityLog mutation.
| Field | Type | Description |
|---|---|---|
result | BulkUpdateResults! | Ids of the created, updated and deleted records, and the items that failed. |
CreateProcessActivityLogPayload object processActivityLog: ProcessActivityLogEntity, clientMutationId: String
Result of the createProcessActivityLog mutation.
| Field | Type | Description |
|---|---|---|
processActivityLog | ProcessActivityLogEntity | The created record. |
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
DeleteProcessActivityLogPayload object processActivityLog: ProcessActivityLogEntity, clientMutationId: String
Result of the deleteProcessActivityLog mutation.
| Field | Type | Description |
|---|---|---|
processActivityLog | ProcessActivityLogEntity | The deleted record. |
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |
UpdateProcessActivityLogPayload object processActivityLog: ProcessActivityLogEntity, clientMutationId: String
Result of the updateProcessActivityLog mutation.
| Field | Type | Description |
|---|---|---|
processActivityLog | ProcessActivityLogEntity | The updated record. |
clientMutationId | String | Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention). |