custom_objects.record_job_get

Ver uma tarefa de registros. Estado de uma tarefa de registros (exportação, importação, alterar ou excluir em massa): state (waiting, active, completed, failed), progress (0 a 100), total, affected, contagens e erros por linha em meta e, na exportação concluída, um downloadUrl novo (vale 5 minutos). Equivale a GET /custom-objects/records-bulk-jobs/{id}; o original consulta de 2 em 2 segundos.

• Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.record_job_get (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: crm:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: custom_objects_record_job_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.record_job_get)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.record_job_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs custom_objects.record_job_get --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta custom_objects_record_job_get com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "kind": {
      "type": "string",
      "enum": [
        "bulk_update",
        "bulk_delete",
        "export",
        "import"
      ]
    },
    "state": {
      "type": "string",
      "enum": [
        "waiting",
        "active",
        "completed",
        "failed"
      ]
    },
    "progress": {
      "type": "number"
    },
    "total": {
      "type": "number"
    },
    "affected": {
      "type": [
        "number",
        "null"
      ]
    },
    "fileName": {
      "type": [
        "string",
        "null"
      ]
    },
    "downloadUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "csv": {
      "type": [
        "string",
        "null"
      ]
    },
    "meta": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "failedReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "finishedAt": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "kind",
    "state",
    "progress",
    "total",
    "affected",
    "fileName",
    "downloadUrl",
    "csv",
    "meta",
    "failedReason",
    "createdAt",
    "finishedAt"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).