(Click to open topic with navigation)
See the associated Services resource section for more information on how to use this resource and supported operations.
Additional references
Type | Value | Additional information |
---|---|---|
Permissions resource | services/hooks/running | Permissions |
Hooks filename | services.hooks.running.groovy | Pre- and Post-Processing Hooks |
Tenant-supported | Yes | Tenants |
Distinct query-supported | Yes | Distinct |
Field Name | Type | PUT | Description |
---|---|---|---|
id | String | No | |
definitionId | String | No |
The hook definition used to create this hook. |
endDate | Date | No |
When the hook completed |
exitCode | Integer | No |
The exit code of the script. |
globalHook | Boolean | No |
Whether the hook came from a global definition or a hook definition on the service. |
processId | Long | No |
The process id of the script. |
serviceId | String | No |
The service id of the service that triggered the hook creation. |
standardError | String | No |
The standard error of the script. |
standardOutput | String | No |
The standard output of the script. |
startDate | Date | No |
When the hook started |
status | ServiceHookStatus | No |
The status of the hook. valid during PUT only if the status is Waiting |
timeoutInSeconds | Long | No |
The duration in seconds before the hook will timeout and terminate automatically, resulting in a failure. Defaults to 900 seconds (15 minutes) when not specified. |
Value | Description |
---|---|
SUCCEEDED | |
FAILED | |
WAITING |
Related Topics