Skip to main content

Enable an object definition

Jetmir Abdija avatar
Written by Jetmir Abdija
Updated over a month ago

This section provides the steps for changing the status of an object definition from disabled to enabled. In case an object definition is already enabled, no error will be thrown.

HTTP responses

HTTP response status code

Interpretation

200 OK

Object definition enabled successfully

400 Bad Request

One or more validation errors occurred:

  • Object definition is secured

  • Object definition is built-in or non-existing

401 Unauthorized

Invalid or missing API key secret and/or tenant

403 Forbidden

The user is not allowed to enable this object definition

To enable an existing disabled object definition, make a POST request to the /object-definitions/{id}/enable endpoint specifying:

  • Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object definition that you want to have enabled in the repository.

  • The header for your API request

To enable the object definition with the id 60eddb38ec9d2656dc75a9f0, we will pass a POST request to the URI https://public-api.eu.bluedolphin.app/v1/object-definitions/60eddb38ec9d2656dc75a9f0/enable.

curl -L -X POST 'https://public-api.eu.bluedolphin.app/v1/object-definitions/60eddb38ec9d2656dc75a9f0/enable' \
-H 'x-api-key: YOURAPIKEYSECRET' \
-H 'tenant: yourtenantname' \
-H 'Content-Type: application/json'

A successful call returns a response with a 200 OK HTTP status code and the following body:

{
    "result": "OK"
}
Did this answer your question?