objects

Embed

<a href="https://hermeticor.com/docs/ref-objects"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/f918c38c-6845-48c7-9417-339f3e6b0dd9/social-card.svg?v=3e7ae33eec8b" alt="objects" width="600" height="315"></a>

DELETEhttps://hermeticor.com/v1/objects/{type}/{id}/links/{profileId}

Parameters

typestringpathrequired

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/objects/{type}/{id}/links/{profileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

GEThttps://hermeticor.com/v1/object-types/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/object-types/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "key": "string",
  "name": "string",
  "fields": {}
}

Schema

idstringrequired

keystringrequired

namestringrequired

fieldsobjectrequired

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

DELETEhttps://hermeticor.com/v1/object-types/{id}

Deletes the type with all its records, relations, versions and logs

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/object-types/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/objects/{type}/{id}/links/{profileId}

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

PATCHhttps://hermeticor.com/v1/object-types/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

{
  "name": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/object-types/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/object-types/{id}

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

GEThttps://hermeticor.com/v1/object-types/{id}/versions

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/object-types/{id}/versions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "version": 0,
      "status": "draft",
      "fields": {},
      "publishedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem146[]required

Show child parameters

idstringrequired

versionintegerrequired

statusstringrequired

draft | published

fieldsobjectrequired

publishedAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

GEThttps://hermeticor.com/v1/object-types/{id}/draft

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/object-types/{id}/draft" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "draft": {
    "id": "string",
    "version": 0,
    "status": "draft",
    "fields": {},
    "publishedAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z"
  }
}

Schema

draftobjectrequired

Show child parameters

idstringrequired

versionintegerrequired

statusstringrequired

draft | published

fieldsobjectrequired

publishedAtstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

PUThttps://hermeticor.com/v1/object-types/{id}/draft

Parameters

idstringpathrequired

Request body

application/json

fieldsobjectrequired

{
  "fields": {}
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/object-types/{id}/draft" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fields":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "version": 0,
  "status": "draft",
  "fields": {},
  "publishedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

versionintegerrequired

statusstringrequired

draft | published

fieldsobjectrequired

publishedAtstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

DELETEhttps://hermeticor.com/v1/object-types/{id}/draft

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/object-types/{id}/draft" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/objects/{type}/{id}/links/{profileId}

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

POSThttps://hermeticor.com/v1/object-types/{id}/draft/publish

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/object-types/{id}/draft/publish" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PUT /v1/object-types/{id}/draft

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

GEThttps://hermeticor.com/v1/object-types/{id}/relationships

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/object-types/{id}/relationships" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "typeId": "string",
      "target": "string",
      "name": "string",
      "cardinality": "one_to_one"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem147[]required

Show child parameters

idstringrequired

typeIdstringrequired

targetstringrequired

namestringrequired

cardinalitystringrequired

one_to_one | one_to_many | many_to_many

nextCursorstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

5XX Default Response

Same as 4XX · DELETE /v1/objects/{type}/{id}/links/{profileId}

Next part

Updated Nov 8, 2026

Was this page helpful?