WorkflowRest Resource
Workflow
- Available Since
- 1.5.11
POST /2.0/workflows/assumeProcessTask
Assign selected instance in pool to the colleague
- Available Since
- 1.5.11
media type | data type | description |
---|---|---|
application/json | AssumeProcessTaskVO (JSON) | Request JSON (example):{
"colleagueId" : "adm", // Colleague id
"processInstanceId" : 1, // Process instance id
"movementSequence" : 1, // Sequence from the task to take
"replacementId" : "usr" // User id from the replacement taking the task for the user
} |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a AssumeProcessTaskResult |
- Available Since
- 1.5.11
POST /2.0/workflows/assumeProcessTasks
Assign selected instances in pool to the specified colleagues
- Available Since
- 1.5.11
media type | data type | description |
---|---|---|
application/json | AssumeProcessTasksVO (JSON) | Request JSON (example):
{"assumeProcessTaskList" :
[
{
"colleagueId" : "adm", // Colleague id
"processInstanceId" : 1, // Process instance id
"movementSequence" : 1, // Sequence from the task to take
"replacementId" : "usr" // User id from the replacement taking the task for the user
},
{
"colleagueId" : "usr", // Colleague id
"processInstanceId" : 2, // Process instance id
"movementSequence" : 1 // Sequence from the task to take
}
]
} |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a AssumeProcessTasksResult |
- Available Since
- 1.6.0
POST /2.0/workflows/cancelInstance
Cancel instance process
- Available Since
- 1.6.0
media type | data type | description |
---|---|---|
application/json | CancelInstanceVO (JSON) | Request JSON (example):{
"processInstanceId" : 1, //Process instance id
"cancelText" : "Canceled", //Cancel text
"replacedId" : "usr" //User id from the replaced cancel process instance
} |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a CancelInstanceResult |
- Available Since
- 1.6.0
POST /2.0/workflows/cancelInstances
Cancel instances process
- Available Since
- 1.6.0
media type | data type | description |
---|---|---|
application/json | CancelInstancesVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.5.8
POST /2.0/workflows/createProcessObservation
Create observation of an existing process.
Return the observation.
- Available Since
- 1.5.8
media type | data type | description |
---|---|---|
application/json | ProcessObservationVO (JSON) | Request JSON (example):{
"processInstanceId" : 15 // Id do artigo que será atualizado (REQUIRED)
"stateSequence" : 4 // Alias da comunidade onde o artigo foi publicado (REQUIRED)
"threadSequence" : 2 // Titulo do Artigo (REQUIRED)
"observation" : "recurso liberado" // Versão do artigo que será atualizado (REQUIRED)
"
}
|
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method returns VO of process observation and a message with the result status |
- Available Since
- 1.6
GET /2.0/workflows/listProcess
Retrieve all processes
Return all processes.
- Available Since
- 1.6
name | type | description | default | constraints |
---|---|---|---|---|
limit | query | 10 | required | |
offset | query | 0 | required | |
pattern | query |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.5.13
GET /2.0/workflows/findActiveTasks/{processInstanceId}
Retrieve active tasks
Return a list of active tasks.
- Available Since
- 1.5.13
name | type | description | constraints |
---|---|---|---|
processInstanceId | path | Process instance Id | int |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ProcessInstanceInfoVO |
- Available Since
- 1.5
GET /2.0/workflows/getProcessVersion/{processId}
Retrieve process version
Return process version.
- Available Since
- 1.5
name | type | description |
---|---|---|
processId | path | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.6.1
GET /2.0/workflows/requests/listSlaProcess
Retrieve all processes
Return all processes whith Sla. Configured
- Available Since
- 1.6.1
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla
Make a resume of the found requests with configurated SLA.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assignee | query | Tasks' assignees user code. | |
assigneeLocals | query | Comma-separated list that contains the activity's responsible local code that will be considered in the search. | |
calculate | query | If the rest will bring the calculated variables related to time e percentage. | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "actualTasks" and/or "cardFields" and/or "requesterLocal" and/or "assigneeLocal" field to return it. | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
manager | query | A manager to be used as parameter to define the processes. | |
order | query | Order by fields. It's possible to order by: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate and endDate. If you want a "DESC" ordenation, put a minus (-) simbol before the order parameter. | -processInstanceId |
page | query | Page number. | 1 |
pageSize | query | Size of the page. | 0 |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. | |
requester | query | Request's requester user code. | |
requesterLocals | query | Comma-separated list that contains the requester's local code that will be considered in the search. | |
statusRequired | query | List separated by comma containing all the status that are being requested, all other counters of the object will not be part of the search. If no values are specified, all status will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResponseEnvelopeVO |
- Available Since
- 1.5
GET /2.0/workflows/requests/tasks
name | type | description | default |
---|---|---|---|
assignee | query | Assignee | |
calculate | query | To calculate SLA | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "cardFields" | |
finalStartDate | query | Final Start Date | |
initialStartDate | query | Initial Start Date | |
manager | query | Manager | |
page | query | Page | 1 |
pageSize | query | Page Size | 0 |
processId | query | Process Id | |
requester | query | Requester | |
statusTypeTaskRequest | query | 1 onTime; 2 warning, 3 Expired Status Required | 1 |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
- Available Since
- 1.5.6
GET /2.0/workflows/getAvailableProcess/{tenantId}/{userId}
Retrieve available process
Return a list of available process. The first level is the category of process, the second level is the process.
- Available Since
- 1.5.6
name | type | description | constraints |
---|---|---|---|
tenantId | path | Request JSON (example):
|
required |
userId | path | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla/resume
Make a resume of the found requests with configurated SLA.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assignee | query | Tasks' assignees user code. | |
assigneeLocals | query | Comma-separated list that contains the activity's responsible local code that will be considered in the search. | |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
countersRequired | query | Comma-separated list that contains all the counters that are being requested, all other counters of the object not return. If no values are specified, all counters will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
manager | query | A manager to be used as parameter to define the processes. | |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. | |
requester | query | Request's requester user code. | |
requesterLocals | query | Comma-separated list that contains the requester's local code that will be considered in the search. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResumeRequestsSLAVO |
- Available Since
- 1.5
GET /2.0/workflows/requests/tasks/resume
name | type | description | default |
---|---|---|---|
assignee | query | ||
finalStartDate | query | ||
initialStartDate | query | ||
manager | query | ||
processId | query | ||
requester | query |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
- Available Since
- 1.6.1
GET /2.0/workflows/requests/{processInstanceId}/sla
Make a resume of the found a specific request with configurated SLA.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
processInstanceId | path | Process Instance Id to be found. | |
calculate | query | If the rest will bring the calculated variables related to time e percentage. | false |
expand | query | Declare the expandable "actualTasks" and/or "cardFields" and/or "requesterLocal" and/or "assigneeLocal" field to return it. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a RequestSLAVO |
- Available Since
- 1.5.8
GET /2.0/workflows/findObservations/{processInstanceId}/{stateSequence}/{threadSequence}
Retrieve available process observations
Return a list of process observations.
- Available Since
- 1.5.8
name | type | description | constraints |
---|---|---|---|
processInstanceId | path | Process instance Id | int |
stateSequence | path | State sequence | int |
threadSequence | path | Thread Sequence | int |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a list of ProcessObservationVO |
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla/assignee/me
Make a resume of the found requests with configurated SLA assuming that the logged user is the assignee.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assigneeLocals | query | Comma-separated list that contains the activity's responsible local code that will be considered in the search. | |
calculate | query | If the rest will bring the calculated variables related to time e percentage. | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "actualTasks" and/or "cardFields" and/or "requesterLocal" and/or "assigneeLocal" field to return it. | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
manager | query | A manager to be used as parameter to define the processes. | |
order | query | Order by fields. It's possible to order by: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate and endDate. If you want a "DESC" ordenation, put a minus (-) simbol before the order parameter. | -processInstanceId |
page | query | Page number. | 1 |
pageSize | query | Size of the page. | 0 |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. | |
requester | query | Request's requester user code. | |
requesterLocals | query | Comma-separated list that contains the requester's local code that will be considered in the search. | |
statusRequired | query | List separated by comma containing all the status that are being requested, all other counters of the object will not be part of the search. If no values are specified, all status will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResponseEnvelopeVO |
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla/manager/me
Make a resume of the found requests with configurated SLA assuming that the logged user is a manager from the process.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assignee | query | Request's assignee user code. | |
assigneeLocals | query | Comma-separated list that contains the activity's responsible local code that will be considered in the search. | |
calculate | query | If the rest will bring the calculated variables related to time e percentage. | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "actualTasks" and/or "cardFields" and/or "requesterLocal" and/or "assigneeLocal" field to return it. | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
order | query | Order by fields. It's possible to order by: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate and endDate. If you want a "DESC" ordenation, put a minus (-) simbol before the order parameter. | -processInstanceId |
page | query | Page number. | 1 |
pageSize | query | Size of the page. | 0 |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. | |
requester | query | Request's requester user code. | |
requesterLocals | query | Comma-separated list that contains the requester's local code that will be considered in the search. | |
statusRequired | query | List separated by comma containing all the status that are being requested, all other counters of the object will not be part of the search. If no values are specified, all status will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResponseEnvelopeVO |
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla/requester/me
Make a resume of the found requests with configurated SLA assuming that the logged user is the requester.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assignee | query | Tasks' assignees user code. | |
calculate | query | If the rest will bring the calculated variables related to time e percentage. | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "actualTasks" and/or "cardFields" and/or "requesterLocal" and/or "assigneeLocal" field to return it. | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
manager | query | A manager to be used as parameter to define the processes. | |
order | query | Order by fields. It's possible to order by: processInstanceId, deadlineDate, processId, requesterCode, requesterName, startDate and endDate. If you want a "DESC" ordenation, put a minus (-) simbol before the order parameter. | -processInstanceId |
page | query | Page number. | 1 |
pageSize | query | Size of the page. | 0 |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. | |
statusRequired | query | List separated by comma containing all the status that are being requested, all other counters of the object will not be part of the search. If no values are specified, all status will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResponseEnvelopeVO |
- Available Since
- 1.5
GET /2.0/workflows/requests/tasks/assignee/me
name | type | description | default |
---|---|---|---|
calculate | query | To calculate SLA | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "cardFields" | |
finalStartDate | query | Final Start Date | |
initialStartDate | query | Initial Start Date | |
manager | query | Manager | |
page | query | Page | 1 |
pageSize | query | Page Size | 0 |
processId | query | Process Id | |
requester | query | Requester | |
statusTypeTaskRequest | query | 1 onTime; 2 warning, 3 Expired Status Required | 1 |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
- Available Since
- 1.5
GET /2.0/workflows/requests/tasks/manager/me
name | type | description | default |
---|---|---|---|
assignee | query | Assignee | |
calculate | query | To calculate SLA | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "cardFields" | |
finalStartDate | query | Final Start Date | |
initialStartDate | query | Initial Start Date | |
page | query | Page | 1 |
pageSize | query | Page Size | 0 |
processId | query | Process Id | |
requester | query | Requester | |
statusTypeTaskRequest | query | 1 onTime; 2 warning, 3 Expired Status Required | 1 |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
- Available Since
- 1.5
GET /2.0/workflows/requests/tasks/requester/me
name | type | description | default |
---|---|---|---|
assignee | query | Assignee | |
calculate | query | To calculate SLA | false |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
expand | query | Declare the expandable "cardFields" | |
finalStartDate | query | Final Start Date | |
initialStartDate | query | Initial Start Date | |
manager | query | Manager | |
page | query | Page | 1 |
pageSize | query | Page Size | 0 |
processId | query | Process Id | |
statusTypeTaskRequest | query | 1 onTime; 2 warning, 3 Expired Status Required | 1 |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla/resume/assignee/me
Make a resume of the found requests with configurated SLA considering that the logged user is an assignee of the request.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assigneeLocals | query | Comma-separated list that contains the activity's responsible local code that will be considered in the search. | |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
countersRequired | query | Comma-separated list that contains all the counters that are being requested, all other counters of the object not return. If no values are specified, all counters will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
manager | query | A manager to be used as parameter to define the processes. | |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. | |
requester | query | Request's requester user code. | |
requesterLocals | query | Comma-separated list that contains the requester's local code that will be considered in the search. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResumeRequestsSLAVO |
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla/resume/manager/me
Make a resume of the found requests with configurated SLA considering that the logged user is a manager of the process.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assignee | query | Request's assignee user code. | |
assigneeLocals | query | Comma-separated list that contains the activity's responsible local code that will be considered in the search. | |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
countersRequired | query | Comma-separated list that contains all the counters that are being requested, all other counters of the object not return. If no values are specified, all counters will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. | |
requester | query | Request's requester user code. | |
requesterLocals | query | Comma-separated list that contains the requester's local code that will be considered in the search. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResumeRequestsSLAVO |
- Available Since
- 1.6.1
GET /2.0/workflows/requests/sla/resume/requester/me
Make a resume of the found requests with configurated SLA considering that the logged user is the requester.
- Available Since
- 1.6.1
name | type | description | default |
---|---|---|---|
assignee | query | Tasks' assignees user code. | |
cardFilters | query | Comma-separated list that contains the card fields of the requests that the resume will be filtered by. The card fields must be made by nameOfTheField:valueOfTheField and at least one process must be defined. If one or more processes defined do not have the field on their cards, the request will return a failure. | |
countersRequired | query | Comma-separated list that contains all the counters that are being requested, all other counters of the object not return. If no values are specified, all counters will be requested. The possible values are: finishedRequests, finishedExpiredRequests, finishedOnTimeRequests, finishedWarningRequests, canceledRequests, canceledExpiredRequests, canceledOnTimeRequests, canceledWarningRequests, openRequests, openExpiredRequests, openOnTimeRequests, openWarningRequests | |
finalDeadlineDate | query | The final date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalStartDate | query | The final date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
finalWarningDate | query | The final date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialDeadlineDate | query | The starting date requested for the request deadline date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialStartDate | query | The starting date requested for the request start date. All dates must be informed in the pattern yyyy-MM-dd. | |
initialWarningDate | query | The starting date requested for the request warning date. All dates must be informed in the pattern yyyy-MM-dd. | |
manager | query | A manager to be used as parameter to define the processes. | |
processes | query | Comma-separated list that contains the process code of the processes that will be considered in the search. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method return a ResumeRequestsSLAVO |
- Available Since
- 1.5
GET /2.0/workflows/requests/tasks/resume/assignee/me
name | type | description | default |
---|---|---|---|
finalStartDate | query | ||
initialStartDate | query | ||
manager | query | ||
processId | query | ||
requester | query |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
- Available Since
- 1.5
GET /2.0/workflows/requests/tasks/resume/manager/me
name | type | description | default |
---|---|---|---|
assignee | query | ||
finalStartDate | query | ||
initialStartDate | query | ||
processId | query | ||
requester | query |
media type | data type | description |
---|---|---|
application/json | object (JSON) |
- Available Since
- 1.5