Update a data format

PATCH

/v1/data-formats/{formatId}

curl -X PATCH 'https://api.embodiflow.io/v1/data-formats/{formatId}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "card": {},
    "converter": {}
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

formatIdstringrequired

Header parameters

if-matchstringrequired
If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.

Request body

Content-Typeapplication/json

cardobject
converterobject

Responses

Success

dataobjectrequired
- idstringrequired
- dataKindstringrequired
  Allowed values
  human
  robot
- slugstringrequired
- statusstringrequired
  Allowed values
  draft
  published
  archived
- currentRevisionnumber | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- draftobjectrequired
- latestSampleRunIdstring | nullrequired
- revisionsarray<TeamDataFormatRevisionDto>required

Response example

{
  "data": {
    "id": "string",
    "dataKind": "human",
    "slug": "string",
    "status": "draft",
    "currentRevision": 0,
    "createdAt": "string",
    "updatedAt": "string",
    "draft": {
      "card": {
        "title": "string",
        "description": "string",
        "illustration": "human",
        "fileRules": {
          "unit": "folder",
          "extensions": [
            "string"
          ],
          "requiredFiles": [
            "string"
          ]
        },
        "requiresTaskSidecar": false,
        "privacyRequirement": "required"
      },
      "converter": {
        "kind": "rig_profile",
        "rigProfileRevisionId": "string"
      }
    },
    "latestSampleRunId": "string",
    "revisions": [
      {
        "id": "string",
        "revision": 0,
        "card": {
          "title": "string",
          "description": "string",
          "illustration": "human",
          "fileRules": {
            "unit": "folder",
            "extensions": [],
            "requiredFiles": []
          },
          "requiresTaskSidecar": false,
          "privacyRequirement": "required"
        },
        "converter": {
          "kind": "rig_profile",
          "rigProfileRevisionId": "string"
        },
        "sampleRunId": "string",
        "publishedAt": "string",
        "publishedBy": "string"
      }
    ]
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

curl -X PATCH 'https://api.embodiflow.io/v1/data-formats/{formatId}' \ -H 'Authorization: Bearer $EMBODIFLOW_PAT' \ -H 'Content-Type: application/json' \ -d '{ "card": {}, "converter": {} }'

{ "data": { "id": "string", "dataKind": "human", "slug": "string", "status": "draft", "currentRevision": 0, "createdAt": "string", "updatedAt": "string", "draft": { "card": { "title": "string", "description": "string", "illustration": "human", "fileRules": { "unit": "folder", "extensions": [ "string" ], "requiredFiles": [ "string" ] }, "requiresTaskSidecar": false, "privacyRequirement": "required" }, "converter": { "kind": "rig_profile", "rigProfileRevisionId": "string" } }, "latestSampleRunId": "string", "revisions": [ { "id": "string", "revision": 0, "card": { "title": "string", "description": "string", "illustration": "human", "fileRules": { "unit": "folder", "extensions": [], "requiredFiles": [] }, "requiresTaskSidecar": false, "privacyRequirement": "required" }, "converter": { "kind": "rig_profile", "rigProfileRevisionId": "string" }, "sampleRunId": "string", "publishedAt": "string", "publishedBy": "string" } ] } }