Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Overview

...

  • newBundle: InputBundle! - The input data for the bundle.

    Status
    colourBlue
    titleRequired

  • oldBundleId: String - The unique identifier of the existing bundle to update.

Returns:

...

Code Block
languagegraphql
mutation {
  saveBundle(
    newBundle: {
      name: "New Bundle",
      projectId: "proj123",
      startDate: "2024-01-01",
      releaseDate: "2024-06-01",
      versionId: "v1.0",
      archived: false,
      description: "Initial bundle",
      children: [{ componentVersionId: "compVersion-10000-10000-10000" }],
      released: true
    },
    oldBundleId: "bundle-10004-9e93307c-12ab-4a6a-9119-e427f0f1e04e"
  ) {
    id
    name
    projectId
    startDate
    releaseDate
    versionId
    description
    archived
    children {
      componentVersionId
    }
    released
  }
}

...

addComponentVersionToBundle

Adds a component version to an existing bundle.

Arguments:

  • bundlebundleId: SaveCVBundleInput String! - The ID of the bundle data.

    Status
    colourBlue
    titleRequired

  • newComponentVersionId: String! - The ID of the new component version to add.

    Status
    colourBlue
    titleRequired

  • oldComponentVersionId: String - The ID of the old component version to replace.

Returns:

Example:

Code Block
languagegraphql
mutation {
  addComponentVersionToBundle(
    bundle: {
      idbundleId: "bundle-10004-9e93307c-12ab-4a6a-9119-e427f0f1e04e",
      name: "Updated Bundle",
      projectId: "proj123",
      startDate: "2024-01-01",
      releaseDate: "2024-06-01",
      versionId: "v1.0",
      archived: false,
      children: [{ componentVersionId: "compVersion-10000-10000-10000" }],
      released: true
    },
    newComponentVersionId: "compVersion-10001-10001-10001",
    oldComponentVersionId: "compVersion-10000-10000-10000"
  ) {
    id
    name
    projectId
    startDate
    releaseDate
    versionId
    description
    archived

   children {
      componentVersionId
    }
    released
  }
}

...

deleteBundle

Deletes a specific bundle by its ID.

...

  • id: String! - The unique identifier of the bundle.

  • name: String! - The name of the bundle.

  • projectId: String! - The unique identifier of the project.

  • startDate: String - The start date of the bundle.

  • releaseDate: String - The release date of the bundle.

  • versionId: String - The version identifier of the bundle.

  • archived: Boolean! - Indicates if the bundle is archived.

  • children: [ComponentVersionBundle] - The component versions included in the bundle.

  • released: Boolean! - Indicates if the bundle is

...

  • id: String - The unique identifier of the bundle.

  • name: String! - The name of the bundle.

    Status
    colourBlue
    titleRequired

  • projectId: String! - The unique identifier of the project.

    Status
    colourBlue
    titleRequired

  • archived: Boolean! - Indicates if the bundle is archived.

    Status
    colourBlue
    titleRequired

  • released: Boolean! - Indicates if the bundle is released.

    Status
    colourBlue
    titleRequired

  • startDate: String - The start date of the bundle.

  • releaseDate: String - The release date of the bundle.

  • versionId: String - The version identifier of the bundle

  • description: String - A description of the bundle.

  • children: [ComponentVersionBundleInput] - The component versions included in the bundle.

SaveCVBundleInput

Input type for adding a component version to a bundle.

Fields:

  • id: String! - The unique identifier of the bundle.

    Status
    colourBlue
    titleRequired

  • name: String! - The name of the bundle.

    Status
    colourBlue
    titleRequired

  • projectId: String! - The unique identifier of the project.

    Status
    colourBlue
    titleRequired

  • released: Boolean! - Indicates if the bundle is released.

    Status
    colourBlue
    titleRequired

  • archived: Boolean! - Indicates if the bundle is archived.

    Status
    colourBlue
    titleRequired

  • startDate: String - The start date of the bundle.

  • releaseDate: String - The release date of the bundle.

  • versionId: String - The version identifier of the bundle.

  • children: [ComponentVersionUIInput]- The component versions included in the bundle.

ComponentVersionUIInput

Input type for specifying a component version within a bundle.

Fields:

  • projectId: String! - The unique identifier of the project.

    Status
    colourBlue
    titleRequired

  • versionId: String! - The unique identifier of the version.

    Status
    colourBlue
    titleRequired

  • componentId: String! - The unique identifier of the component.

    Status
    colourBlue
    titleRequired

ComponentVersionBundleInput

...

  • bundle

...

Fields:

  • componentVersionId: String! - The unique identifier of the component version. StatuscolourBluetitleRequired