objects

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-objects"><img src="https://hermetica.15.204.158.166.sslip.io/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>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/object-types

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/object-types" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "fields": {}
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

keystringrequired

namestringrequired

fieldsobjectrequired

nextCursorstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/object-types

POSThttps://hermetica.15.204.158.166.sslip.io/v1/object-types

Request body

application/json

keystringrequired

namestringrequired

fieldsobject

= {}

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

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/object-types" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","name":"string","fields":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

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

Schema

idstringrequired

keystringrequired

namestringrequired

fieldsobjectrequired

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

GEThttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}

Parameters

limitintegerquery

= 50

cursorstringquery

typestringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "typeId": "string",
      "externalId": "string",
      "name": "string",
      "attributes": {},
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

typeIdstringrequired

externalIdstringrequired

namestringrequired

attributesobjectrequired

createdAtstringrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

POSThttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}

Parameters

typestringpathrequired

Request body

application/json

externalIdstring

namestringrequired

attributesobject

= {}

{
  "externalId": "string",
  "name": "string",
  "attributes": {}
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"externalId":"string","name":"string","attributes":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "typeId": "string",
  "externalId": "string",
  "name": "string",
  "attributes": {},
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

typeIdstringrequired

externalIdstringrequired

namestringrequired

attributesobjectrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

GEThttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/external/{externalId}

Look up by your own external id

Parameters

typestringpathrequired

externalIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/external/{externalId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "typeId": "string",
  "externalId": "string",
  "name": "string",
  "attributes": {},
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "links": [
    {
      "profileId": "string",
      "role": "string",
      "labels": [
        "string"
      ]
    }
  ]
}

Schema

idstringrequired

typeIdstringrequired

externalIdstringrequired

namestringrequired

attributesobjectrequired

createdAtstringrequired

updatedAtstringrequired

linksobject[]required

Show child parameters

profileIdstringrequired

rolestringrequired

labelsstring[]required

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/external/{externalId}

Parameters

typestringpathrequired

externalIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/external/{externalId}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

GEThttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}

Parameters

typestringpathrequired

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/objects/{type}/external/{externalId}

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}

Parameters

typestringpathrequired

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/objects/{type}/external/{externalId}

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}

Parameters

typestringpathrequired

idstringpathrequired

Request body

application/json

namestring

attributesobject

{
  "name": "string",
  "attributes": {}
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","attributes":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/objects/{type}

4XX Default Response

Same as 4XX · GET /v1/object-types

5XX Default Response

Same as 4XX · GET /v1/object-types

POSThttps://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}/links

Parameters

typestringpathrequired

idstringpathrequired

Request body

application/json

profileIdstringrequired

rolestring

{
  "profileId": "string",
  "role": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/objects/{type}/{id}/links" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","role":"string"}'

TypeScript

Python

PHP

Ruby

Java