VTEX · Schema

NewTaskRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
target array
domain string
context string
name string
priority string
surrogateKey string
description string
dueDate string
assignee object
followers array
parentTaskId string
View JSON Schema on GitHub

JSON Schema

vtex-newtaskrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NewTaskRequest",
  "title": "NewTaskRequest",
  "required": [
    "target",
    "domain",
    "context",
    "name",
    "priority",
    "surrogateKey",
    "description",
    "dueDate",
    "assignee",
    "followers",
    "parentTaskId"
  ],
  "type": "object",
  "properties": {
    "target": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Target"
      },
      "description": ""
    },
    "domain": {
      "type": "string"
    },
    "context": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "priority": {
      "type": "string"
    },
    "surrogateKey": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "dueDate": {
      "type": "string"
    },
    "assignee": {
      "$ref": "#/components/schemas/Assignee"
    },
    "followers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Follower"
      },
      "description": ""
    },
    "parentTaskId": {
      "type": "string",
      "nullable": true
    }
  },
  "example": {
    "target": [
      {
        "id": "633730670642-01",
        "type": "order",
        "url": "https://recorrenciaqa.vtexcommercebeta.com.br/admin/checkout/orders/633730670642-01"
      }
    ],
    "domain": "oms",
    "context": "Marketplace",
    "name": "pricing",
    "priority": "Critical",
    "surrogateKey": "505224-0",
    "description": "Ajudar na doc API para lancar no postman",
    "dueDate": "2016-03-01",
    "assignee": {
      "id": null,
      "name": null,
      "email": "[email protected]"
    },
    "followers": [
      {
        "id": null,
        "name": null,
        "email": "[email protected]"
      }
    ],
    "parentTaskId": null
  }
}