About this resource
Representation of a FileProcessAction
Properties
| Property | Description | Type |
|---|---|---|
| id | Gets the identifier for this file process action. | guid |
| name | Gets the name of this file process action. | string |
| fileProcessActionStageId | Gets the file process action stage identifier. | guid |
| fileProcessActionType | Gets the file process action type. | byte |
| sortIndex | Gets the sort index for this file process action. | short |
| isConfigurable | Gets whether this file process action is configurable. | boolean |
| enabled | Gets whether this file process action is enabled. | boolean |
| executeOnFirstFileVersionOnly | Gets whether this file process action executes on first file version only. | boolean |
| createdOn | Gets the creation date for this file process action. | datetime |
| modifiedOn | Gets the modification date for this file process action. | datetime |
| labels | Gets the collection of labels for this file process action. | LabelCollection |
| conditions | Gets the collection of conditions for this file process action. See File Process Condition Types for available condition types. | FileProcessConditionCollection |
Relations
Actions
| Method | Action | Description | Response codes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PUT /fileprocessaction/{fileProcessActionId} | edit | Edits an existing file process action |
|
File Process Condition Types
File process actions can have conditions that determine when they should be executed. The conditions property contains a FileProcessConditionCollection which may include any of the following condition types:
- FileTypeCondition - Restricts the action to specific file types based on file type IDs.
- ContentTypeIsCondition - Restricts the action based on the content type of the record.
- ClassifiedInCondition - Restricts the action to records classified in a specific classification.
- OnlyOnFirstVersionCondition - Restricts the action to execute only on the first version of a file.
- CompareFieldValueCondition - Evaluates a conditional expression against field values to determine if the action should execute.