AplasAplas API Reference

Add targets for a relationship type

STRICTLY ADDITIVE — adds a relation to each target not already connected, and removes nothing. Idempotent: re-adding an existing target is a no-op.

POST
/workspaces/{workspaceId}/asset-types/{typeId}/assets/{assetId}/relations/{relationshipType}

Authorization

BearerAuth
AuthorizationBearer <token>

API authentication via Authorization: Bearer <your-api-key>. Obtain your API key from Config → API in the Aplas web app.

In: header

Path Parameters

workspaceId*string

The workspace's slug.

typeId*string

The asset type's slug.

assetId*string

The asset's slug. Unique within its asset type, not across the workspace — which is why assets are addressed beneath their type.

relationshipType*string

The relationship type's slug.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.au.aplas.com/api/v3/workspaces/string/asset-types/string/assets/string/relations/string" \  -H "Content-Type: application/json" \  -d '{    "targets": [      {        "type": "string",        "id": "string"      }    ]  }'
{
  "written": 0
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}
{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "The permissions of your API key only allow read-only/GET calls."
}