Create a component instance

Creates an instance of a component and returns it under the component’s name.

POST /component/{component_uuid}

cURL

cURL

curl -X POST "$EXSITED_BASE_URL/api/v4/component/5c8e1f2a-3b4d-4e6f-9a0b-1c2d3e4f5a6b" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "service_contract": {
      "parents": [
        {
          "type": "account",
          "id": "ACC0001"
        }
      ]
    }
  }'

201

{}

Creates a new instance of the component with this dashed uuid. The body has one key, the component’s name, holding the instance’s fields, such as parents naming the account that owns it. The new instance comes back under the same key.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

component_uuid · string · required

The component's dashed uuid, not its cmp_ id. It is the uuid the component has in the GET /settings/components listing.

Body

application/json

One key, the component's name, holding the instance's fields.

{key} · object

Show child attributes

Response

201 - application/json

The new instance, under the component's name.

One key, the component's name, holding the instance.

{key} · object

Show child attributes