Projects: Components

🔒 Создание нового компонента архитектуры продукта.

Создание нового компонента архитектуры продукта.

Access: authorized (10 ) · Scope: write

Allows: product:structure (все обязательны; ресурс — productID)

TypeScript (copy-paste)

POST /projects/component/create

<details open><summary><b>Body (Partial)</b></summary>
// Patch-body: все поля опциональны (Valid.Patch)
export type ProjectsComponentCreateBody = Partial<Component>

export interface ProjectsComponentCreateBodyFields {
  cID?: string
  projectID?: string
  productID?: string
  ID?: string
  ver?: number
  title?: string
  desc?: string
  designID?: string | null
  isDeleted?: boolean | null
  /** Unix timestamp in milliseconds */
  deletedTS?: number | null
  /** Unix timestamp in milliseconds */
  updTS?: number
  updUID?: string
}
</details> <details open><summary><b>Response</b></summary>
export type ProjectsComponentCreateResponse = IServerResponse<Component>

export interface IServerResponse<T = any> {
  code: number
  data: T
  srvTS: number
  rkey: string
}
</details>

Полный файл типов: /docs/types · raw: /docs/api-types.ts

post/projects/component/create

Request

  • Base URL: http://localhost
  • URL: http://localhost/projects/component/create
  • Auth: one of:
    • API key in header sid and API key in header rts and API key in header sig
    • HTTP bearer

Headers

devIDstring uuid required

UUID устройства клиента

tzstring required
Example:Europe/Moscow

Таймзона клиента (IANA или offset)

appstring required
Example:kosmodrom-web

Имя клиентского приложения

appVerstring required
Example:1.0.0

Версия клиента

rKeystring

Уникальный ключ запроса для логов/саппорта

Request body

cIDstring uuid
projectIDstring uuid
productIDstring uuid
IDstring uuid
verinteger
titlestring
descstring
designIDstring uuid nullable
isDeletedboolean nullable
deletedTSinteger nullable

Unix timestamp in milliseconds

updTSinteger

Unix timestamp in milliseconds

updUIDstring

Response

OK — IServerResponse<Component>

codeinteger required
srvTSinteger required

Server timestamp (ms)

rkeystring required

Request key

Example response

{
  "code": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.