Workflow Template
Criação e gerenciamento de templates de workflow
Os template de workflow são modelos que podem ser pré-configurados e reutilizados para criar os workflows de fato. Caso queira saber mais, veja os exemplos de uso dos templates, bem como um exemplo usando nossa página de integração.
Criar template de workflow
POST https://api-v1.assine.online/v1/workflow-template
Cria o template de workflow
Headers
Authorization
string
Bearer <access-token>
Content-Type
string
application/json
Accept
string
application/json
Request Body
type
integer
Tipo do template que estamos criando, sendo os possíveis valores: 0 - Temporário, será apagado depois de um tempo. Usado na página de integração. (Default) 1 - Permanente, para reuso.
name
string
Um nome de identificação para este template.
settings
object
Definições acerca do template.
settings.canAddSigners
boolean
Permite que na página de integração, a pessoa inclua assinantes. Default: false.
template
object
Um objeto idêntico ao corpo de criação de um workflow. Veja a página de workflow para mais detalhes de quais dados passar nesse objeto.
{
"id": 21,
"type": 0,
"token": "e2dvb2RfbG9va317ImRhdGEiOnsidHlwZSI6InRlbXBsYXRlIiwiaWQiOjIxfSwiaG1hYyI6Ijg3N2M5ZjBiNWE3MDIzOWNkZDQ1Y2E3MDIxYTkwNWY5M2RiMzYyYzEzNGFiNTllN2U5MGNjN2VjZGE3NzNiYTciLCJub25jZSI6Ijk5MzQxNTgyODM0MjY4In0=",
"title": "Template created",
"status": 201,
"detail": "Template created"
}A propriedade de token que é retorna serve para ser usada na página de integração.
Listar templates de workflow
GET https://api-v1.assine.online/v1/workflow-template
Lista todos os templates de workflow criados
Query Parameters
page
string
Página que deseja buscar
Headers
Authorization
string
Bearer <access-token>
Content-Type
string
application/json
{
"_links": {
"self": {
"href": "https://api.assine.online/v1/workflow-template?page=1"
},
"first": {
"href": "https://api.assine.online/v1/workflow-template"
},
"last": {
"href": "https://api.assine.online/v1/workflow-template?page=1"
}
},
"_embedded": {
"workflow_template": [
{
"id": 21,
"type": 0,
"name": "Nome do template",
"dateCreated": {
"date": "2020-02-27 20:11:08.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"dateUpdated": null,
"_embedded": {
"user": {
"id": 474,
"name": "Jhon Doe",
"email": "[email protected]",
"_links": {
"self": {
"href": "https://api.assine.online/v1/user/474"
}
}
}
},
"_links": {
"self": {
"href": "https://api.assine.online/v1/workflow-template/21"
}
}
},
...
]
},
"page_count": 1,
"page_size": 25,
"total_items": 1,
"page": 1Buscar um template de workflow
GET https://api-v1.assine.online/v1/workflow-template/:id
Busca um template de workflow
Path Parameters
id
number
ID do template de workflow
Headers
Authorization
string
Bearer <access-token>
Content-Type
string
application/json
{
"id": 21,
"template": {
"autoRemind": 0,
"dueDate": "2023-01-01 23:59:59",
"message": "Comentário opcional",
"priority": 0,
"sla": 1,
"files": [
{
"idFile": 5602,
"name": "Meu documento",
"specialFields": [],
"workflowSteps": [
{
"user": {
"name": "Jhon Doe",
"email": "[email protected]"
},
"action": 0,
"signatureType": 0,
"fields": []
}
],
"_embedded": {
"file": {
"_links": {
"download": {
"href": "https://api.assine.online/file?q=e2dvb2RfbG9va317ImRhdGEiOnsidXVpZCI6IjNkZDYxMjc0LTU5OWQtMTFlYS1hODNiLTAyNDJhYzE1MDAwNyJ9LCJobWFjIjoiYTJmMjUxNmI1MjNmMzc1MGUzMzJkY2M0MmQ5NzVhMWQ0MDQwZjE0NmVmMTQxYWI2MzJiNTMyNWM3ODcyMmZkYSIsIm5vbmNlIjoiNjEwMTE1ODI4MzQ3NzIifQ=="
}
}
}
}
}
]
},
"settings": {
"canAddSigners": true
},
"token": "e2dvb2RfbG9va317ImRhdGEiOnsidHlwZSI6InRlbXBsYXRlIiwiaWQiOjIxfSwiaG1hYyI6IjEwNTRiZmI2MDVjMTRjZDlhYmU0Y2QzYjM0MWE5NDFmODU4YjRmZjIzMDk4NWNmNWNlZWJmYmE2OGEyNzViZWQiLCJub25jZSI6IjYxNjMxNTgyODM0NzcyIn0=",
"type": 0,
"title": "",
"status": 200,
"detail": ""
}Atualizar template de workflow
PATCH https://api-v1.assine.online/v1/workflow-template/:id
Atualiza o template de workflow
Path Parameters
id
integer
ID do template de workflow
Query Parameters
token
string
O token gerado que permite edição do template de workflow
Request Body
type
integer
Tipo do template que estamos criando, sendo os possíveis valores: 0 - Temporário, será apagado depois de um tempo. Usado na página de integração. (Default) 1 - Permanente, para reuso.
name
string
Um nome de identificação para este template.
template
object
Um objeto idêntico ao corpo de criação de um workflow. Veja a página de workflow para mais detalhes de quais dados passar nesse objeto.
{
"id": 21,
"type": 0,
"template": {
"autoRemind": 0,
"dueDate": "2023-01-01 23:59:59",
"message": "Comentário opcional",
"priority": 0,
"sla": 1,
"files": [
{
"idFile": 5602,
"name": "Meu documento",
"specialFields": [],
"workflowSteps": [
{
"user": {
"name": "Jhon Doe",
"email": "[email protected]"
},
"action": 0,
"signatureType": 0,
"fields": []
}
]
}
]
},
"settings": {
"canAddSigners": true
},
"title": "Template updated",
"status": 200,
"detail": "Template updated"
}Ao atualizar, você não deve informar a propriedade settings , caso precise alterar as permissões neste template, crie um novo.
Remover template de workflow
DELETE https://api-v1.assine.online/v1/workflow-template/:id
Remove o template de workflow
Path Parameters
id
number
ID do template de workflow
Headers
Authorization
string
Bearer <access-token>
Accept
string
application/json
Last updated
Was this helpful?