``compactFilter`` |
required oneOf(``compactFilter``, ``detailFilter``), object |
Filter to limits the result. Using a ``compactFilter`` narrows down the results to commit information only. To obtain objects of specific commits, use the ``detailFilter``. |
"compactFilter" : {
"from" : "-30d",
"to" : "-5d"
} |
|
``account`` |
optional, string |
Account that deployed objects. |
{
"account": "root"
}
|
|
``folder`` |
optional, string |
Path to a folder. |
{
"folder": "/myWorkflows/ifElseWorkflows"
}
|
|
``controllerId`` |
optional, string |
Identifies the controller the deployment was performed for. |
{
"controllerId": "testsuite"
}
|
|
``deployType`` |
optional, string |
Type of the deployed object. Subset of deployable objects from the enum ConfigurationType. The subset consists of WORKFLOW, LOCK, NOTICEBOARD, FILEORDERSOURCE. |
{
"deployType": "WORKFLOW"
}
|
|
``operation`` |
optional, string |
The operation of the deployment. Possible values are UPDATE, DELETE. |
{
"operation": "UPDATE"
}
|
|
``state`` |
optional, string |
Status of the deployment. Possible values are DEPLOYED, NOT_DEPLOYED |
{
"state": "DEPLOYED"
}
|
|
``deploymentDate`` |
optional, string |
Date when the deployment was done. |
{
"deploymentDate": "2020-11-06T11:00:00Z"
}
|
|
``deleteDate`` |
optional, string |
Date when an deployment was deleted from a Controller. |
{
"deleteDate": "2020-11-06T11:00:00Z"
}
|
|
``from`` |
optional, string |
The value has multiple formats
- format for a date in ISO 8601 format where the time offset and milliseconds are optional, e.g.
- YYYY-MM-DDThh:mm:ss[.s][Z (Z means +00)]
- YYYY-MM-DDThh:mm:ss[.s][+01:00]
- YYYY-MM-DDThh:mm:ss[.s][+0100]
- YYYY-MM-DDThh:mm:ss[.s][+01]
- a format for a time period in relative to the current time, e.g. 6h, 12h, 1d, 1w can specify in addition with a time offset 0 or digits followed by a letter are expected where the letter has to be:
- s (seconds)
- m (minutes)
- h (hours)
- d (days)
- w (weeks)
- M (months)
- y (years)
- a time offset is optional (e.g. 2d+02:00)
- it can be also specify with the parameter ``timeZone``
- if ``timeZone`` undefined then UTC is used
- the value 0 means the current time
- start date of a range of dates
|
{
"from": "-10d"
}
|
|
``to`` |
optional, string |
The value has multiple formats like the ``from`` parameter
- end date of a range of dates
|
{
"to": "0d"
}
|
|
``timeZone`` |
optional, string |
- If this parameter is set then it beats the time offset in ``dateFrom`` and ``dateTo``
- See here the list for available time zones.
|
{
"timezone": "Europe/Berlin"
}
|
|
``limit`` |
optional, integer |
Limits the number of delivered items, -1=unlimited |
{
"limit": "5000"
}
|
10000 |
``detailFilter`` |
required oneOf(``compactFilter``, ``detailFilter``), object |
Filter to limit the results. Using a ``detailFilter`` will deliver a set of objects. To obtain commit information only, use the ``compactFilter``. |
"detailFilter" : {
"commitId" : "b62bdb71-9553-45bc-8d22-33b32d96d6bf",
"deployType" : "WORKFLOW"
} |
|
``account`` |
optional, string |
see above. |
|
|
``path`` |
optional, string |
Path of a single deployed object. |
{
"path": "/myWorkflows/ifElseWorkflows/test_workflow_01"
}
|
|
``folder`` |
optional, string |
see above. |
|
|
``controllerId`` |
optional, string |
see above. |
|
|
``commitId`` |
optional, string |
Commit ID of the deployment. |
{
"commitId": "4cbb095d-b998-4091-92f2-4fb8efb58805"
}
|
|
``version`` |
optional, string |
User defined version of a deployed object. |
{
"version": "0.0.1"
}
|
|
``deployType`` |
optional, string |
Type of the deployed object. Subset of deployable objects from the enum ConfigurationType. The subset consists of WORKFLOW, LOCK, BOARD, FILEORDERSOURCE. |
{
"deployType": "WORKFLOW"
}
|
|
``operation`` |
optional, string |
The operation of the deployment. Possible values are UPDATE, DELETE. |
{
"operation": "UPDATE"
}
|
|
``state`` |
optional, string |
Status of the deployment. Possible values are DEPLOYED, NOT_DEPLOYED |
{
"state": "DEPLOYED"
}
|
|
``deploymentDate`` |
optional, Date |
see above. |
|
|
``deleteDate`` |
optional, Date |
see above. |
|
|
``from`` |
optional, string |
see above. |
|
|
``to`` |
optional, string |
see above. |
|
|
``timeZone`` |
optional, string |
see above. |
|
|
``limit`` |
optional, integer |
see above. |
|
10000 |