Skip to main content

WorkflowDeployment

idstring<uuid>required
rootProjectIdstring<uuid>required
statusWorkflowDeploymentStatusrequired

Possible values: [planned, preparing, prepared, publishing, published, failed]

manifest objectrequired
versionintegerrequired
Constant value: 1
rootProjectIdstring<uuid>required
projects object[]required

Possible values: >= 1

  • Array [
    • projectIdstring<uuid>required
    rolestringrequired

    Possible values: [root, dependency]

    archivePathstringrequired

    A secure relative .tgz or .tar.gz path within the project-group archive.

    aliasstring

    Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$

  • ]
    • dependencies object[]required
  • Array [
    • aliasstringrequired

    Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$

    projectIdstring<uuid>required
    deliverystringrequired

    Possible values: [included, external]

    versionstring

    included rely on the exact version of post-release solidification; external do not carry.

    Possible values: Value must match regular expression ^\d+\.\d+\.\d+$

    sourceHashstring

    included rely on source code hash solidified after release; external do not carry.

    Possible values: Value must match regular expression ^[a-f0-9]{64}$

  • ]
    • releaseLogstringrequired
    createdByUserIdstringrequired
    errorstring
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
    publishedAtstring<date-time>
    items object[]required
  • Array [
    • deploymentIdstring<uuid>required
    projectIdstring<uuid>required
    aliasstring
    rolestringrequired

    Possible values: [root, dependency]

    deliverystringrequired
    Constant value: included
    statusWorkflowDeploymentStatusrequired

    Possible values: [planned, preparing, prepared, publishing, published, failed]

    stagestring
    plannedVersionstring
    preparedSourceHashstring

    Possible values: Value must match regular expression ^[a-f0-9]{64}$

    publishedVersionstring
    publishedSourceHashstring

    Possible values: Value must match regular expression ^[a-f0-9]{64}$

    errorstring
    updatedAtstring<date-time>required
  • ]
    • WorkflowDeployment
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "rootProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "planned",
      "manifest": {
        "version": 1,
        "rootProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "projects": [
          {
            "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "role": "root",
            "archivePath": "string",
            "alias": "string"
          }
        ],
        "dependencies": [
          {
            "alias": "string",
            "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "delivery": "included",
            "version": "string",
            "sourceHash": "string"
          }
        ]
      },
      "releaseLog": "string",
      "createdByUserId": "string",
      "error": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "publishedAt": "2024-07-29T15:51:28.071Z",
      "items": [
        {
          "deploymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "alias": "string",
          "role": "root",
          "delivery": "included",
          "status": "planned",
          "stage": "string",
          "plannedVersion": "string",
          "preparedSourceHash": "string",
          "publishedVersion": "string",
          "publishedSourceHash": "string",
          "error": "string",
          "updatedAt": "2024-07-29T15:51:28.071Z"
        }
      ]
    }