Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Projects are versioned. This is to support editing a Project after it has been ordered and allow reordering an older version (for example, from Order History). A Project Version can be thought of as a "snapshop" of the Project at at a point in time. That "snapshot" can then be printed.

Versions are identified by an incrementing unsigned integer i.e. version "1", version "2" etc. When a project is created, an initial version, "1" is automatically created.

Versions are made up of one or more Project Artifacts. A version is considered complete when it has more than one Artifact and all Artifacts are themselves complete (i.e. no incomplete Required Artifacts).

Requires:

Actions

URLVerbInformation
/project/{Guid}/versionPOSTCreates a new version for the Project identified by Guid
/project/{Guid}/version/{Number}GETRetrieves the details for the version

Attributes

No additional data other than that required in the URL is required when creating a new version.

The following fields are returned when requesting the details of a Version:

FieldData TypeRequiredInformation
NumberIntegerYThe version number. Auto-incrementing for the project.
IsCompleteBooleanY

Whether this version can be ordered.

ArtifactsArray Of Project ArtifactsYArtifacts that make up the version.
CreatedDateTimeUtcDateTimeYThe date time the version was created, in UTC
LastSavedDateTimeUtcDateTimeYThe date time the version was last saved, in UTC
  • No labels