{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Task API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Task",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex List tasks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/tasks",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "assignee.email",
                "value": "",
                "type": "query",
                "description": "If you wish to list tasks by assignee, insert the desired assignee's email and status."
              },
              {
                "name": "target.id",
                "value": "",
                "type": "query",
                "description": "If you wish to list tasks by target, insert the desired `targetId` and `status`."
              },
              {
                "name": "context",
                "value": "",
                "type": "query",
                "description": "If you wish to list tasks by context, insert the desired context, `page`, `perPage` and `status`."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "If you wish to list tasks by context, also insert the desired `page`."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "If you wish to list tasks by context, also insert the desired `perPage` value."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "If you wish to list tasks by context, also insert the desired `status`."
              }
            ]
          },
          "docs": "This endpoint allows you to filter tasks. You can choose between the following filtering options: \r\n\r\n- **Assignees:** using `assignee.email` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?assignee.email={{person@email.com}}&status={{open}}`. \r\n\r\n- **Targets:** using `targetId` and `status`. Example: `https://{{accountName}}.{{environment}}.com.br/api/do/tasks?target.id={{name}}&status={{open}}`. \r\n\r\n- **Paged tasks:** using `page`, `perPage` and `status`. Ex"
        },
        {
          "info": {
            "name": "VTex Create Task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/tasks",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new task in VTEX DO."
        },
        {
          "info": {
            "name": "VTex Retrieve Task",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/tasks/:taskId",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID."
              }
            ]
          },
          "docs": "Retrieves a given task, filtering by `taskId`."
        },
        {
          "info": {
            "name": "VTex Update Task",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{providerApiEndpoint}/tasks/:taskId",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a given task's status, for example, filtering by `taskId`."
        },
        {
          "info": {
            "name": "VTex Add Comment on a Task",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/tasks/:taskId/comments",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Task ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a comment to a given task, filtering by `taskId`."
        }
      ]
    }
  ],
  "bundled": true
}