Create a definition
POST /api/v1/projects/{projectId}/definitions
Create a definition with its initial immutable revision.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Create a definition. |
Request body
Required — Request body for: Create a definition.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
kind | "domain" | "integration" | "operation" | "presentation" | required | |
slug | string | required | |
name | string | required | |
source | object | required | |
attachments | array<object> | optional |
Responses
| Status | Description | Body |
|---|---|---|
201 | Response for status 201 | application/json — object — id: string (required); projectId: string (required); kind: "domain" | "integration" | "operation" | "presentation" (required); slug: string (required); name: string (required); status: "active" | "deleting" (required); latestRevision: object | null (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |