Create a custom relationship

POST 
/pcm/custom_relationships

Create a custom relationship

Request

application/json

Body

required

data object

type stringrequired

Possible values: [custom-relationship]

This represents the type of resource object being returned. Always custom-relationship.

attributes objectrequired

name string

The name of the custom relationship, such as Kitchen electrics.

description string

A description of the custom relationship.

slug string

A unique slug for the custom relationship. Must match the slug specified in the request path.

Responses

201

Returns a created custom relationship with the following attributes.

application/json

Schema

Schema

data object

id string

A unique identifier generated when a custom relationship is created.

type string

Possible values: [custom-relationship]

This represents the type of resource object being returned. Always hierarchy.

attributes object

name string

The name of the custom relationship, such as Kitchen electrics.

description string

A description of the custom relationship.

slug string

A unique slug for the custom relationship.

meta object

owner string

The owner of the resource.

timestamps object

created_at date-time

The date and time the resource is created.

updated_at date-time

The date and time the resource is updated.

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "custom-relationship",
    "attributes": {
      "name": "string",
      "description": "string",
      "slug": "string"
    },
    "meta": {
      "owner": "store",
      "timestamps": {
        "created_at": "2024-01-10T20:16:35.343Z",
        "updated_at": "2024-01-10T20:16:35.343Z"
      }
    }
  }
}

created-custom-relationship

{
  "data": {
    "type": "custom-relationship",
    "id": "f3297ee8-da90-45e9-ae56-a2654aebbdfe",
    "attributes": {
      "name": "Kitchen electrics",
      "description": "Kitchen electric devices",
      "slug": "CRP_kitchen_individual_devices"
    },
    "meta": {
      "owner": "store",
      "timestamps": {
        "created_at": "2024-01-10T20:16:35.343Z",
        "updated_at": "2024-01-10T20:16:35.343Z"
      }
    }
  }
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

failed-validation

{
  "errors": [
    {
      "title": "Failed Validation",
      "status": "422",
      "detail": "<XYZ> can not be empty"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors undefined[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": "500",
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Loading...