Skip to main content
POST
/
resources
/
batch
curl -X POST 'https://api.example.com/resources/batch' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "resourceTypeId": "resource_type_document",
      "scopeId": "scope_engineering",
      "externalResourceId": "doc-123",
      "displayName": "Project Roadmap"
    },
    {
      "resourceTypeId": "resource_type_document",
      "scopeId": "scope_engineering",
      "externalResourceId": "doc-456",
      "displayName": "API Specification"
    }
  ]'

[
  {
    "id": "resource_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "resourceTypeId": "resource_type_document",
    "scopeId": "scope_engineering",
    "externalResourceId": "doc-123",
    "displayName": "Project Roadmap",
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "system"
  },
  {
    "id": "resource_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5c",
    "resourceTypeId": "resource_type_document",
    "scopeId": "scope_engineering",
    "externalResourceId": "doc-456",
    "displayName": "API Specification",
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "system"
  }
]

​
Overview

Batch creation allows you to create multiple resources in a single API call.
ID Format: All IDs use a namespaced UUIDv7 format: resource_{uuidv7}.

​
Request Body

Array of resource objects:
​
[].id
string
Optional client-provided ID
​
[].resourceTypeId
string
required
ID of the resource type
​
[].scopeId
string
required
ID of the owning scope
​
[].externalResourceId
string
required
External identifier for the resource
​
[].displayName
string
Display name for the resource

​
Response

Returns an array of created resource objects. 
curl -X POST 'https://api.example.com/resources/batch' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "resourceTypeId": "resource_type_document",
      "scopeId": "scope_engineering",
      "externalResourceId": "doc-123",
      "displayName": "Project Roadmap"
    },
    {
      "resourceTypeId": "resource_type_document",
      "scopeId": "scope_engineering",
      "externalResourceId": "doc-456",
      "displayName": "API Specification"
    }
  ]'

[
  {
    "id": "resource_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "resourceTypeId": "resource_type_document",
    "scopeId": "scope_engineering",
    "externalResourceId": "doc-123",
    "displayName": "Project Roadmap",
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "system"
  },
  {
    "id": "resource_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5c",
    "resourceTypeId": "resource_type_document",
    "scopeId": "scope_engineering",
    "externalResourceId": "doc-456",
    "displayName": "API Specification",
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "system"
  }
]