Create or upsert an entry

Add a catalog object events can reference.

POST /v1/entries

Create or update an ontology-backed entry

cURL

curl --request POST \
  --url https://api.swapnice.com/v1/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "ontology": "<string>",
  "owner_id": "<string>",
  "ingestion_origin": "<string>",
  "entry_name": "<string>",
  "fields": {},
  "entry_id": "<string>",
  "value": 123,
  "image_upload_status": "uploaded",
  "media": {
    "primary_image": "<string>",
    "gallery": [
      "<string>"
    ]
  }
}
'

200

{
  "status": "created",
  "entry": {
    "entry_id": "<string>",
    "ontology": "<string>",
    "entry_name": "<string>",
    "owner_id": "<string>",
    "ingestion_origin": "<string>",
    "value": 123,
    "image_upload_status": "uploaded",
    "media": {
      "primary_image": "<string>",
      "gallery": [
        "<string>"
      ]
    },
    "fields": {},
    "checksum": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Add a catalog object events can reference.

Use the returned entry_id as object on events. Guide: entries and ontologies.

Authorizations

Authorization · string · header · required

OAuth 2.1 authorization code with PKCE. Implicit and password flows are unsupported.

Headers

Idempotency-Key · string · required

Required for mutating requests. Replays with the same key and payload hash return the original logical result; replays with a different payload hash return 409.

Required string length: 16 - 255

Body

application/json

ontology · string · required

owner_id · string · required

ingestion_origin · string · required

entry_name · string · required

fields · object · required

entry_id · string

Optional when deterministic identity fields can derive it.

value · number string

image_upload_status · enum<string> · default: uploaded

Available options: uploaded, staged, missing

media · object

Show child attributes

Response

200

application/json

Entry created, updated, or unchanged.

status · enum<string> · required

Available options: created, updated, unchanged

entry · object · required

Show child attributes