Executar workflow-run com verbo PATCH

PATCH 
/v1/workflows/:workflow/run

Executar workflow-run com verbo PATCH

Request

Path Parameters

workflow stringrequired
ID do workflow
Example: wrkf_5f92f01728e009f403d8502e

application/json

Body

object

application/octet-stream

Body

object

Responses

200

Ok

application/json

Schema

Schema

object

Example (from schema)

{}

400

Error

application/json

Schema

Schema

type string
error
Possible values: [error]
Example: error
status int32
O status HTTP da resposta
Example: 400
code string
Um código de erro específico da Base39
Possible values: [created, accepted, no_content, redirect, not_modified, bad_request, unauthorized, forbidden, not_found, method_not_allowed, conflict, precondition_failed, too_many_requests, internal_server_error, unavailable, item_name_invalid, insufficient_scope]
Example: item_name_invalid
message string
Uma breve descrição do erro
Example: Method Not Allowed

context

object

Um objeto de formato livre que contém contexto adicional sobre o erro. Os campos possíveis são definidos por endpoint. message é apenas um exemplo.

message string

More details on the error.

Example: Something went wrong.
help string
Um URL com links para mais informações sobre o motivo da ocorrência desse erro.
Example: https://docs.paketa.com.br/development/first-steps/errors
request string
Um identificador exclusivo para esta resposta, que pode ser usado ao entrar em contato com o suporte da Base39.
Example: abcdef123456

Example (from schema)

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context": {
    "message": "Something went wrong."
  },
  "help": "https://docs.paketa.com.br/development/first-steps/errors",
  "request": "abcdef123456"
}

406

Not Acceptable

application/json

Schema

Schema

code stringrequired
Código do erro.
Example: RESPONSE_NOT_ACCEPTABLE
message stringrequired
Mensagem do erro.
Example: statusCode must be one of the following values: 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 421, 422, 423, 424, 425, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511

Example (from schema)

{
  "code": "RESPONSE_NOT_ACCEPTABLE",
  "message": "statusCode must be one of the following values: 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 421, 422, 423, 424, 425, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511"
}

Loading...