Definitions

ForeignKeyResource

A reference to another resource in the API.

Name Description Schema

id
optional

The id of the other resource.
Example : 0

integer (int32)

link
optional

Example : Link

Link

text
optional

The type of the other resource
Example : "Other Resource"

string

Link

Details of a link to another resource

Name Description Schema

href
optional

The location the Link is referencing.
Example : "http://alm.example.local:8080/alm/rest/v1/link/href/1"

string

rel
optional

The relation of the Link to the parent view.
Example : "LinkRel"

string

title
optional

The title of the Link.
Example : "Title"

string

LinkedResource

A reference to a constant subresource.

Name Description Schema

id
optional

The internal value of the linked SubResource.
Example : 0

integer (int32)

link
optional

Example : Link

Link

text
optional

The (localized) name of the linked SubResource.
Example : "Value for 0"

string

XmlAgentStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlAgentStatusList

Name Description Schema

agentstatuses
optional

Example : [ "XmlAgentStatus" ]

< XmlAgentStatus > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

XmlApprovalStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlApprovalStatusList

Name Description Schema

approvalstatuses
optional

Example : [ "XmlApprovalStatus" ]

< XmlApprovalStatus > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

XmlApprovalType

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlApprovalTypeList

Name Description Schema

approvaltypes
optional

Example : [ "XmlApprovalType" ]

< XmlApprovalType > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

XmlApprovalView

Details of a specific Approval.

Name Description Schema

approve-datetime
optional

The date on which the Approval was approved or rejected.
Example : "2019-11-22T08:17:39"

string

approved-by-user
optional

The User that handled the approval.
Example : ForeignKeyResource

ForeignKeyResource

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level-id
optional

The Level the Approval was requested for.
Example : "1"

string

levelrequest
optional

The Level Request the Approval was requested for.
Example : ForeignKeyResource

ForeignKeyResource

links
optional

Example : [ "Link" ]

< Link > array

projectstream
optional

The Project Stream the Approval was requested for.
Example : ForeignKeyResource

ForeignKeyResource

reason
optional

The Reason the User approved or rejected the Approval.
Example : "Approved By User X"

string

sequence-number
optional

The position of the approval in the sequence of approvals.
Example : 1

integer (int32)

status
optional

The Status of the approval (0=Unknown; 1=Awaiting Approval; 2=Awaiting Approval Predecessor; 3=Approved; 4=Rejected; 5=Cancelled; 6=Awaiting Level Request Finish).
Example : LinkedResource

LinkedResource

type
optional

The Type of the approval (1=Post-Approval 2=Pre-Approval).
Example : LinkedResource

LinkedResource

usergroup
optional

The User Group that is to handle the Approval.
Example : ForeignKeyResource

ForeignKeyResource

XmlApprovalViewList

A list of Approvals

Name Description Schema

approvals
optional

A paginated list of Approvals that may be filtered and sorted.
Example : [ "XmlApprovalView" ]

< XmlApprovalView > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlApprovePatchView

A view for approving or rejecting an Approval

Name Description Schema

approve
optional

Whether to approve (true) or reject (false) the Approval.
Example : true

boolean

reason
optional

The reason to approve or reject the Approval. Required if rejecting the approval, optional if approving.
Example : "Approved by User X"

string

XmlAuthenticationView

Details of a specific user session. In case of a Post action, only provide the username and password.

Name Description Schema

email-address
optional

The Email Address of the current user.
Example : "user@example.com"

string

is-administrator
optional

Whether the user is part of the ALM Administrator usergroup.
Example : false

boolean

is-reserved-user
optional

Whether the user is a reserved user.
Example : true

boolean

locale
optional

The locale of the logged in user.
Example : "en"

string

login-date
optional

The date the user logged into the current session.
Example : "2019-11-22T08:17:39"

string

login-host-ip
optional

The IP Address of the host machine the user used to log in.
Example : "0:0:0:0:0:0:0:1"

string

login-hostname
optional

The hostname of the machine the user used to log in.
Example : "localhost"

string

password
optional

The password to use to login as.
Example : "user"

string

user-fullname
optional

The Username of the user.
Example : "User"

string

username
optional

The User Id to login as.
Example : "user"

string

XmlBuildArchiveStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlBuildArchiveStatusList

Name Description Schema

archivestatuses
optional

Example : [ "XmlBuildArchiveStatus" ]

< XmlBuildArchiveStatus > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

XmlBuildStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlBuildStatusList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

statuses
optional

Example : [ "XmlBuildStatus" ]

< XmlBuildStatus > array

XmlBuildType

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlBuildTypeList

Name Description Schema

buildtypes
optional

Example : [ "XmlBuildType" ]

< XmlBuildType > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

XmlBuildView

Details of a specific Build.

Name Description Schema

archived-status
optional

The Archive Status of the Build File.
Example : LinkedResource

LinkedResource

build-environment-id
optional

The identifier of the Build Environment on which the Build was requested.
Example : 1

integer (int32)

build-environment-name
optional

The Name of the Build Environment on which the Build was requested.
Example : "CONTBUILD"

string

build-number
optional

The Number of the Build.
Example : 1

integer (int32)

duration
optional

The duration of the Build Execution in milliseconds.
Example : 1000

integer (int64)

end-datetime
optional

The Date and Time on which the Build ended.
Example : "2019-11-22T08:17:39"

string

file-name
optional

The Name of the Build File produced by the Build.
Example : "result.zip"

string

file-size
optional

The Size of the Build File produced by the Build in bytes.
Example : 178890402

integer (int64)

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

is-tagged-build
optional

Whether the Build is tagged in the VCR.
Example : true

boolean

levelrequest
optional

A reference to the Level Request the Build is part of.
Example : ForeignKeyResource

ForeignKeyResource

links
optional

Example : [ "Link" ]

< Link > array

machine-name
optional

The Name of the Machine on which the Build was requested.
Example : "ALMServer"

string

start-datetime
optional

The Date and Time on which the Build started.
Example : "2019-11-22T08:17:39"

string

status
optional

The Status of the Build.
Example : LinkedResource

LinkedResource

XmlBuildViewList

Name Description Schema

builds
optional

Example : [ "XmlBuildView" ]

< XmlBuildView > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlCLRView

A container view for creating a Level Request

Name Description Schema

build-number
optional

Optional build number, can be set for a deliver or rollback Level Request (e.g. 88)
Example : "30"

string

deploys-to-execute
optional

Comma separated list of the names of the deploy environments to execute. Only relevant if Optional Deploys are enabled on the Level) (e.g. testDeploy1, testDeploy2)"));
Example : "DeployEnv1,DeployEnv2"

< string > array

description
optional

Optional description of the Level Request (e.g. Build created with REST Interface)
Example : "Level Request description"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level
optional

Name of the Level to create a Level Request for (e.g. TEST)
Example : "LevelName"

string

links
optional

Example : [ "Link" ]

< Link > array

package
optional

Optional Package to create a Level Request for (e.g. pack-1)
Example : "PackageName"

string

parameters
optional

A map of build and/or deploy parameters needed to create the Level Request.
Example : { "string" : "string" }

< string, string > map

project
optional

Name of the Project to create a Level Request for
Example : "ProjectName"

string

projectstream
optional

Optional [build prefix]-[build-suffix] of the Project Stream (e.g. 1-0) to create a Level Request for
Example : "1-0"

string

redeliver
optional

Allow redelivering a Build to a test or production Level (disabled by default)(true or false)
Example : "true"

string

start-date
optional

Optional requested starting Date and Time (format dd/MM/yyyy HH:mm) (e.g. 20/10/2019 18:00)
Example : "2019-11-22T08:17:39+0000"

string

tag
optional

Optional tag with which the build will be tagged in the VCR (e.g. H_1-0_b1)
Example : "B1-0_1"

string

XmlCRUFileRevisionView

Properties for a FileRevision to create or modify.

Name Description Schema

action
optional

The Action to perform on the File Revision. Can be either create, modify or delete.
Example : "create"

string

name
optional

The Name of the File Revision to create or update.
Example : "readme.txt"

string

path
optional

The Path of the File Revision to create or update.
Example : "/demo/"

string

revision
optional

The Revision number in the VCR of the File Revision to create or update.
Example : "1"

string

XmlCRUPackageResultView

A newly created or updated Package and related File Revisions.

Name Description Schema

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

package
optional

Example : XmlPackageView

XmlPackageView

packagecru-report
optional

Provides information on the status of individual steps during the Creation or Update of a Package and/or related File Revisions.
Example : [ "string" ]

< string > array

validation-errors
optional

Shows any validation problems that occurred during the Create or Update of a Package and/or related File Revisions.
Example : { "string" : "string" }

< string, string > map

XmlCRUPackageView

Properties for a Package and associated File Revisions to create or update.

Name Description Schema

archived
optional

Whether the Package should be hidden.
Example : false

boolean

description
optional

The Description of the Package to create or update.
Example : "Description for the new package"

string

filerevisions
optional

A list of File Revisions to create or update alongside the Package.
Example : [ "XmlCRUFileRevisionView" ]

< XmlCRUFileRevisionView > array

name
optional

The Name of the Package to create or update.
Example : "example_package"

string

owner
optional

${documentation.XmlCRUPackageView.Owner}
Example : 1

integer (int32)

project
optional

The Name of the Project for which to create a Package.
Example : "package_project"

string

projectstream
optional

The Prefix and Suffix of a Project Stream for which to create a Package.
Example : "1-0"

string

status
optional

${documentation.XmlCRUPackageView.Status}
Example : 0

integer (int32)

target-release-date
optional

${documentation.XmlCRUPackageView.TargetReleaseDate}
Example : "2060-10-31"

string

XmlCRUProjectStreamView

Properties for a Project Stream.

Name Description Schema

accept-forced-build
optional

Optional boolean to indicate whether the project stream accepts forced builds. If not provided, defaults to true.
Example : true

boolean

archived
optional

Optional boolean to hide the project stream. If not provided, defaults to false.
Example : false

boolean

buildprefix
optional

Project stream buildprefix
Example : "1-0"

string

buildsuffix
optional

Project stream buildsuffix, will be ignored for a head project stream
Example : "1-1"

string

buildtype
optional

Optional integer to indicate project stream build type, e.g 0 is Full Build. Integer with possible values 0-3. If not provided, defaults to 0 (Full Build).
Example : 1

integer (int32)

description
optional

Optional string, description of the project stream
Example : "description"

string

highest-buildnumber
optional

Optional integer, project stream highest build number. If not provided, defaults to 0.
Example : 0

integer (int32)

is-head
optional

Optional boolean to indicate if this will be a head (true) or branch (false) project stream. If not provided, defaults to false (Branch).
Example : false

boolean

is-tagbased
optional

Optional boolean to build this project steam based on existing tags. If not provided, defaults to false.
Example : false

boolean

lifecycle-oid
optional

Oid of existing lifecycle in the project
Example : 1

integer (int32)

locked
optional

Optional boolean to lock the branch. If not provided, defaults to false.
Example : false

boolean

project-oid
optional

oid of existing project
Example : 1

integer (int32)

status
optional

Optional integer to indicate project stream status, e.g 0 is Under Construction. Integer with possible values 0-7. If not provided, defaults to 0 (Under Construction).
Example : 1

integer (int32)

tag-template
optional

Optional template for the VCR tag of newly created level Requests. If not provided, defaults to a generic value based on the Project type: "${streamType}_${prefix}_${suffix_b${buildNumber}" for released based projects, "${streamType}_${prefix}_${suffix}_${packageName}_b${buildNumber}" for package based projects.
Example : "${streamType}_${prefix}_${suffix}_b${buildNumber}"

string

vcr-branch-id
optional

Id of the branch, required for branch project streams, and for the head of a TFVC connected project
Example : "COMMON/branches/JDK11"

string

XmlCreateLevelRequestView

Details of the newly created Level Request.

Name Description Schema

buildnumber
optional

Build Number
Example : 1

integer (int32)

description
optional

Description
Example : "The description of the created Level Request"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level-id
optional

Level Identifier
Example : 1

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

package-id
optional

Identifier of the Package
Example : 1

integer (int32)

projectstream
optional

Project Stream
Example : ForeignKeyResource

ForeignKeyResource

requested-datetime
optional

Requested Date and Time
Example : "2019-11-22T08:17:39"

string

tag
optional

VCR Tag
Example : "B1-0_1"

string

user
optional

Name of the User
Example : ForeignKeyResource

ForeignKeyResource

XmlDeployStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlDeployStatusList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

statuses
optional

Example : [ "XmlDeployStatus" ]

< XmlDeployStatus > array

XmlDeployView

Details of a specific Deploy.

Name Description Schema

deploy-environment-id
optional

The identifier of the Deploy Environment on which the Deploy was requested.
Example : 1

integer (int32)

deploy-environment-name
optional

The Name of the Deploy Environment on which the Deploy was requested.
Example : "ALMServer"

string

duration
optional

The duration of the Deploy Execution in milliseconds.
Example : 1000

integer (int64)

end-datetime
optional

The Date and Time on which the Deploy ended.
Example : "2019-11-22T08:17:39"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

levelrequest
optional

A reference to the Level Request the Deploy is part of.
Example : ForeignKeyResource

ForeignKeyResource

links
optional

Example : [ "Link" ]

< Link > array

machine-name
optional

The Name of the Machine on which the Deploy was requested.
Example : "ALMServer"

string

sequence-number
optional

The position of the Deploy in the sequence of Deploys.
Example : 1

integer (int32)

start-datetime
optional

The Date and Time on which the Deploy started.
Example : "2019-11-22T08:17:39"

string

status
optional

The Status of the Deploy.
Example : LinkedResource

LinkedResource

XmlDeployViewList

Name Description Schema

count
optional

Example : 0

integer (int32)

deploys
optional

Example : [ "XmlDeployView" ]

< XmlDeployView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlExportableBuildEnvironmentView

Name Description Schema

build-script
optional

Example : "string"

string

build-suffix
optional

Example : "string"

string

buildenvironmentparameters
optional

Example : [ "XmlExportableBuildParameterView" ]

< XmlExportableBuildParameterView > array

buildtoolref
optional

Example : "string"

string

debug
optional

Example : true

boolean

downloadable-build
optional

Example : true

boolean

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level-oid
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

machineref
optional

Example : "string"

string

name
optional

Example : "string"

string

oid
optional

Example : 0

integer (int32)

phases
optional

Example : [ "XmlExportableEnvironmentPhaseView" ]

< XmlExportableEnvironmentPhaseView > array

source-location
optional

Example : "string"

string

target-location
optional

Example : "string"

string

user-parameters
optional

Example : true

boolean

XmlExportableBuildParameterView

Name Description Schema

description
optional

Example : "string"

string

dynamic
optional

Example : true

boolean

editable
optional

Example : true

boolean

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

key
optional

Example : "string"

string

links
optional

Example : [ "Link" ]

< Link > array

mandatory
optional

Example : true

boolean

oid
optional

Example : 0

integer (int32)

secured
optional

Example : true

boolean

user-controlled
optional

Example : true

boolean

value
optional

Example : "string"

string

XmlExportableDeployEnvironmentView

Name Description Schema

build-environment-oid
optional

Example : 0

integer (int32)

debug
optional

Example : true

boolean

deploy-script
optional

Example : "string"

string

deployenvironmentparameters
optional

Example : [ "XmlExportableDeployParameterView" ]

< XmlExportableDeployParameterView > array

deploytoolref
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level-oid
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

machineref
optional

Example : "string"

string

name
optional

Example : "string"

string

oid
optional

Example : 0

integer (int32)

partial-deploy
optional

Example : true

boolean

phases
optional

Example : [ "XmlExportableEnvironmentPhaseView" ]

< XmlExportableEnvironmentPhaseView > array

sequence-number
optional

Example : 0

integer (int32)

source-location
optional

Example : "string"

string

target-location
optional

Example : "string"

string

user-parameters
optional

Example : true

boolean

XmlExportableDeployParameterView

Name Description Schema

description
optional

Example : "string"

string

dynamic
optional

Example : true

boolean

editable
optional

Example : true

boolean

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

key
optional

Example : "string"

string

links
optional

Example : [ "Link" ]

< Link > array

mandatory
optional

Example : true

boolean

oid
optional

Example : 0

integer (int32)

secured
optional

Example : true

boolean

user-controlled
optional

Example : true

boolean

value
optional

Example : "string"

string

XmlExportableEnvironmentPhaseParameterView

Name Description Schema

globalphaseparameter
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

integrationref
optional

Example : "string"

string

integrationtype
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Example : "string"

string

oid
optional

Example : 0

integer (int32)

value
optional

Example : "string"

string

XmlExportableEnvironmentPhaseView

Name Description Schema

description
optional

Example : "string"

string

environment-oid
optional

Example : 0

integer (int32)

environment-type
optional

Example : 0

integer (int32)

fail-on-error
optional

Example : true

boolean

firstphase
optional

Example : true

boolean

globalphase
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

next-phase-on-fail-oid
optional

Example : 0

integer (int32)

next-phase-on-success-oid
optional

Example : 0

integer (int32)

next-phase-on-warning-oid
optional

Example : 0

integer (int32)

oid
optional

Example : 0

integer (int32)

parameters
optional

Example : [ "XmlExportableEnvironmentPhaseParameterView" ]

< XmlExportableEnvironmentPhaseParameterView > array

phase-name
optional

Example : "string"

string

phase-version
optional

Example : "string"

string

XmlExportableLevelView

Name Description Schema

buildenvironments
optional

Example : [ "XmlExportableBuildEnvironmentView" ]

< XmlExportableBuildEnvironmentView > array

debug
optional

Example : true

boolean

deployenvironments
optional

Example : [ "XmlExportableDeployEnvironmentView" ]

< XmlExportableDeployEnvironmentView > array

description
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

locked
optional

Example : true

boolean

name
optional

Example : "string"

string

notification-criteria
optional

Example : 0

integer (int32)

notification-type
optional

Example : 0

integer (int32)

oid
optional

Example : 0

integer (int32)

phases
optional

Example : [ "XmlExportableEnvironmentPhaseView" ]

< XmlExportableEnvironmentPhaseView > array

post-notification-criteria
optional

Example : 0

integer (int32)

postapprovals
optional

Example : [ "XmlExportablePostApprovalUserGroupAssociationView" ]

< XmlExportablePostApprovalUserGroupAssociationView > array

postnotification-usergroupref
optional

Example : "string"

string

preapprovals
optional

Example : [ "XmlExportablePreApprovalUserGroupAssociationView" ]

< XmlExportablePreApprovalUserGroupAssociationView > array

prenotification-usergroupref
optional

Example : "string"

string

requester-usergroupref
optional

Example : "string"

string

scheduleref
optional

Example : "string"

string

type
optional

Example : 0

integer (int32)

XmlExportableLifecycleAssociationView

Name Description Schema

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level-oid
optional

Example : 0

integer (int32)

lifecycle-oid
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

oid
optional

Example : 0

integer (int32)

optional
optional

Example : true

boolean

optional-deploy
optional

Example : true

boolean

sequence-number
optional

Example : 0

integer (int32)

XmlExportableLifecycleView

Name Description Schema

description
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

is-base
optional

Example : true

boolean

lifecycle-associations
optional

Example : [ "XmlExportableLifecycleAssociationView" ]

< XmlExportableLifecycleAssociationView > array

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Example : "string"

string

oid
optional

Example : 0

integer (int32)

XmlExportablePostApprovalUserGroupAssociationView

Name Description Schema

controlled-by-usergroup
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level-oid
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

oid
optional

Example : 0

integer (int32)

sequencenumber
optional

Example : 0

integer (int32)

XmlExportablePreApprovalUserGroupAssociationView

Name Description Schema

controlled-by-usergroup
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

levelOid
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

oid
optional

Example : 0

integer (int32)

sequencenumber
optional

Example : 0

integer (int32)

XmlExportableProjectStreamView

Name Description Schema

accept-forced-build
optional

Example : true

boolean

archived
optional

Example : true

boolean

buildprefix
optional

Example : "string"

string

buildsuffix
optional

Example : "string"

string

buildtype
optional

Example : 0

integer (int32)

description
optional

Example : "string"

string

highest-buildnumber
optional

Example : 0

integer (int32)

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

is-head
optional

Example : true

boolean

is-tagbased
optional

Example : true

boolean

lifecycle-oid
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

locked
optional

Example : true

boolean

oid
optional

Example : 0

integer (int32)

partial-build-tag
optional

Example : "string"

string

status
optional

Example : 0

integer (int32)

tag-template
optional

Example : "string"

string

vcr-branch-id
optional

Example : "string"

string

XmlExportableProjectView

Name Description Schema

admingroupref
optional

Example : "string"

string

archived
optional

Example : true

boolean

buildscript
optional

Example : "string"

string

deployscript
optional

Example : "string"

string

description
optional

Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

issuetrackingsystemref
optional

Example : "string"

string

links
optional

Example : [ "Link" ]

< Link > array

locked
optional

Example : true

boolean

name
optional

Example : "string"

string

oid
optional

Example : 0

integer (int32)

projecttype
optional

Example : 0

integer (int32)

usergroupref
optional

Example : "string"

string

vcr-projectname
optional

Example : "string"

string

vcrref
optional

Example : "string"

string

XmlFileRevisionView

Details of a specific File Revision.

Name Description Schema

name
optional

The Name of the File Revision.
Example : "readme.txt"

string

path
optional

The Path of the File Revision.
Example : "/demo/"

string

revision
optional

The Revision number in the VCR of the File Revision.
Example : "1"

string

XmlFileRevisionViewList

A list of File Revisions

Name Description Schema

count
optional

Example : 0

integer (int32)

filerevisions
optional

A list of File Revisions.
Example : [ "XmlFileRevisionView" ]

< XmlFileRevisionView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlGitView

Details of a specific Git Repository

Name Description Schema

cache-location
optional

Cache Location
Example : "file:///C:/almdemo/repository/git/"

string

clone-with-filter-blob-none
optional

Clone with –filter=blob:none
Example : true

boolean

command-path
optional

Command Path
Example : "c:/vcrs/git/bin"

string

default-branch-name
optional

Default Branch Name
Example : "main"

string

description
optional

Description
Example : "description"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Name
Example : "GITRepository"

string

password
optional

Password
Example : "**"

string

repository-push-url
optional

Repository URL
Example : "file:///C:/almdemo/repository/git/"

string

repository-url
optional

Repository URL
Example : "file:///C:/almdemo/repository/git/"

string

timeout
optional

Time-Out (seconds)
Minimum value : 30
Maximum value : 3600
Example : 30

integer (int32)

type
optional

Repository Type (git)
Example : "git"

string

user-id
optional

User ID
Example : "gituser"

string

XmlGitViewList

A list of Git Repositories

Name Description Schema

count
optional

Example : 0

integer (int32)

gits
optional

A paginated list of Git Repositories that may be filtered and sorted
Example : [ "XmlGitView" ]

< XmlGitView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlGlobalRefResource

Details of a Reference to a Global Object that 'exists' (should exist) in the IKAN ALM Instance 'from the exported Project' ('where the Project will be imported')

Name Description Schema

attributes
optional

The Global Reference attributes needed to link to a specific global object. Mostly the 'name' attribute is sufficient, but sometimes additional attributes (type, phaseVersion,…) are needed to uniquely identify the Object.
Example : { "string" : "string" }

< string, string > map

refid
optional

Identifier of a Global Reference Object. Will be used as replacing identifier in the Project Tree when linking a Project Object to a Global object, e.g. globalref-14.
Example : 1

integer (int32)

type
optional

The Global Reference type (vcr, its=Issue Tracking System, usergroup, schedule, tool, machine, phase, phaseparameter, transporterprotocol, unknown).
Example : "vcr"

string

XmlIssueTrackingSystemPropertyView

Details of a specific Issue Tracking System Property

Name Description Schema

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Name
Example : "restUrl"

string

secured
optional

Secured
Example : true

boolean

value
optional

Property Value
Example : "http://api.example.com"

string

XmlIssueTrackingSystemPropertyViewList

A list of Issue Tracking System Properties

Name Description Schema

count
optional

Example : 0

integer (int32)

issuetrackingsystemproperties
optional

${documentation.XmlIssueTrackingSystemPropertyView.value}
Example : [ "XmlIssueTrackingSystemPropertyView" ]

< XmlIssueTrackingSystemPropertyView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlIssueTrackingSystemView

Details of a specific Issue Tracking System

Name Description Schema

add-comments
optional

Add Comments
Example : true

boolean

description
optional

Description
Example : "description"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

issue-id-pattern
optional

Issue ID Pattern
Example : "[0-9]+"

string

issue-pattern
optional

Issue Pattern
Example : "[0-9A-Z][0-9A-Z][0-9A-Z]*-[0-9]+"

string

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Name
Example : "ALM Issues System"

string

password
optional

Password
Example : "p@ssw0rd"

string

plugin-factory-class
optional

Example : "string"

string

url
optional

URL
Example : "http://example.com/issues/${issueId}"

string

user
optional

User
Example : "username"

string

XmlIssueTrackingSystemViewList

A list of Issue Tracking Systems

Name Description Schema

count
optional

Example : 0

integer (int32)

issuetrackingsystems
optional

${documentation.XmlIssueTrackingSystemViewList.value}
Example : [ "XmlIssueTrackingSystemView" ]

< XmlIssueTrackingSystemView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlIssueView

Details of a specific Issue.

Name Description Schema

description
optional

The Description of the Issue.
Example : "Example Issue Description"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

issue-id
optional

The identifier of the Issue in the Issue Tracking System.
Example : "Example Issue Id"

string

links
optional

Example : [ "Link" ]

< Link > array

owner
optional

The Owner of the Issue in the Issue Tracking System.
Example : "Example Issue Owner"

string

priority
optional

The Priority of the Issue.
Example : "Example Issue Priority"

string

status
optional

The Status of the Issue.
Example : "Example Issue Status"

string

url
optional

The Url of the Issue in the Issue Tracking System.
Example : "Example Issue Url"

string

XmlIssueViewList

Name Description Schema

count
optional

Example : 0

integer (int32)

issues
optional

Example : [ "XmlIssueView" ]

< XmlIssueView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlLevelRequestActionType

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlLevelRequestActionTypeList

Name Description Schema

actiontypes
optional

Example : [ "XmlLevelRequestActionType" ]

< XmlLevelRequestActionType > array

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

XmlLevelRequestPatchView

A view for updating, cancelling or aborting a Level Request

Name Description Schema

description
optional

Description of the Level Request to be updated.
Example : "Level Request description"

string

requested-datetime
optional

Requested Date and Time of the Level Request to be updated, in correct format (e.g M/d/yy h:mm a).
Example : "2019-11-22T08:17:39"

string

status
optional

Target Status of the Level Request you want to Cancel (status=8) or Abort (status=10).
Example : 10

integer (int32)

XmlLevelRequestResultView

Details of a specific Level Request.

Name Description Schema

action-type
optional

The ActionType of the Level Request.
Example : LinkedResource

LinkedResource

build-number
optional

The Build Number of the Level Request.
Example : 1

integer (int32)

created-by-user
optional

A reference to the User who requested the Level Request.
Example : ForeignKeyResource

ForeignKeyResource

created-on-datetime
optional

The Date and Time on which the Level Request was created.
Example : "2019-11-22T08:17:39"

string

createdby-user-id
optional

The Name of the User who requested the Level Request.
Example : "global"

string

description
optional

The Description of the Level Request.
Example : "Build Level Request for Example Project"

string

end-datetime
optional

The Date and Time on which the Level Request ended.
Example : "2019-11-22T08:17:39"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

level-id
optional

The identifier of the Level for which the Level Request was requested.
Example : 1

integer (int32)

level-name
optional

The Name of the Level for which the Level Request was requested.
Example : "Build"

string

links
optional

Example : [ "Link" ]

< Link > array

package
optional

A reference to the Package for which the Level Request was requested.
Example : ForeignKeyResource

ForeignKeyResource

project
optional

A reference to the Project for which the Level Request was requested.
Example : ForeignKeyResource

ForeignKeyResource

project-name
optional

The Name of the Project for which the Level Request was requested.
Example : "Example_Project"

string

projectstream
optional

A reference to the Project Stream for which the Level Request was requested.
Example : ForeignKeyResource

ForeignKeyResource

projectstream-short-notation
optional

The Project Stream for which the Level Request was requested.
Example : "Example_Project H_1-0"

string

requested-datetime
optional

The Date and Time on which the Level Request was requested to start.
Example : "2019-11-22T08:17:39"

string

start-datetime
optional

The Date and Time on which the Level Request started.
Example : "2019-11-22T08:17:39"

string

status
optional

The Status of the Level Request.
Example : LinkedResource

LinkedResource

type
optional

The Type of the Level Request.
Example : LinkedResource

LinkedResource

vcr-tag
optional

The Tag the Level Request is tagged with in the VCR.
Example : "H_1-0_1"

string

XmlLevelRequestResultViewList

A list of Level Requests

Name Description Schema

count
optional

Example : 0

integer (int32)

levelrequests
optional

A paginated list of Level Request Results that may be filtered and sorted.
Example : [ "XmlLevelRequestResultView" ]

< XmlLevelRequestResultView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlLevelRequestStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlLevelRequestStatusList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

statuses
optional

Example : [ "XmlLevelRequestStatus" ]

< XmlLevelRequestStatus > array

XmlLevelRequestType

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlLevelRequestTypeList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

types
optional

Example : [ "XmlLevelRequestType" ]

< XmlLevelRequestType > array

XmlLifecycleView

Details of a specific Lifecycle

Name Description Schema

description
optional

Description
Example : "description"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

is-base
optional

Whether this is a base or branch Lifecycle
Example : true

boolean

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Name
Example : "maintenancelifecycle"

string

project
optional

The Project connected to the Lifecycle
Example : ForeignKeyResource

ForeignKeyResource

XmlLifecycleViewList

A list of Lifecycles

Name Description Schema

count
optional

Example : 0

integer (int32)

lifecycles
optional

${documentation.LifecycleViewList.value}
Example : [ "XmlLifecycleView" ]

< XmlLifecycleView > array

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlMachineStatusView

Agent Log or Status Details of a specific Machine

Name Description Schema

agent-log
optional

Agent Log
Example : "string"

string

agentstatus
optional

Agent Status (0=Shutting Down, 1=Idle, 2=Running Builds, 3=Running Deploys, 4=Running Builds and Deploys, 5=Could not connect)
Example : LinkedResource

LinkedResource

dhcp-enabled
optional

DHCP Enabled
Example : true

boolean

dhcp-name
optional

DHCP Name
Example : "string"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

ip-address
optional

IP Address
Example : "127.0.0.1"

string

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Name
Example : "ALMServer"

string

serverstatus
optional

Server Status (O=Shutting Down, 1=Idle, 2=Running Level Requests, 3=Could not connect)
Example : LinkedResource

LinkedResource

XmlMachineView

Details of a specific Machine

Name Description Schema

agent-port
optional

Agent Port
Example : 20020

integer (int32)

description
optional

Description
Example : "description"

string

dhcp-enabled
optional

DHCP Enabled
Example : true

boolean

dhcp-name
optional

DHCP Name
Example : "almserver.example.com"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

ip-address
optional

IP Address
Example : "127.0.0.1"

string

job-limit
optional

Concurrent Deploy Limit
Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

locked
optional

Whether the Machine is Locked or not
Example : true

boolean

name
optional

Name
Example : "ALMServer"

string

operatingsystem
optional

Operating System
Example : LinkedResource

LinkedResource

server-port
optional

Server Port
Example : 20021

integer (int32)

transporterprotocol-id
optional

Identifier of the Transporter Protocol linked to the Machine
Example : 1

integer (int32)

transporterprotocol-name
optional

Name of the Transporter Protocol linked to the Machine
Example : "Local FileCopy"

string

XmlMachineViewList

A list of Machines

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

machines
optional

A paginated list of Machines that may be filtered and sorted
Example : [ "XmlMachineView" ]

< XmlMachineView > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlOperatingSystem

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlOperatingSystemList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

operatingsystems
optional

Example : [ "XmlOperatingSystem" ]

< XmlOperatingSystem > array

XmlPackageStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlPackageStatusList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

statuses
optional

Example : [ "XmlPackageStatus" ]

< XmlPackageStatus > array

XmlPackageView

Details of a package

Name Description Schema

archived
optional

Whether the Package is hidden.
Example : false

boolean

description
optional

The Description of the Package.
Example : "Description for the package"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

latest-levelrequest
optional

Example : ForeignKeyResource

ForeignKeyResource

links
optional

Example : [ "Link" ]

< Link > array

name
optional

The Name of the Package.
Example : "example_package"

string

owner
optional

The Owner of the package.
Example : ForeignKeyResource

ForeignKeyResource

project
optional

Example : ForeignKeyResource

ForeignKeyResource

project-name
optional

The Name of the Project the Package is part of.
Example : "H_1-0"

string

projectstream
optional

Example : ForeignKeyResource

ForeignKeyResource

projectstream-short-notation
optional

The Project Stream the Package is part of.
Example : "H_1-0"

string

status
optional

The Status of the Package (0=Active, 1=Frozen, 2=Archived).
Example : LinkedResource

LinkedResource

target-release-date
optional

The Target Release Date of the Package.
Example : "2030-11-22"

string

XmlPackageViewList

A list of Packages

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

packages
optional

${documentation.XmlPackageViewList.value}
Example : [ "XmlPackageView" ]

< XmlPackageView > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

XmlPhaseLogFormatType

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlPhaseLogFormatTypeList

Name Description Schema

count
optional

Example : 0

integer (int32)

formattypes
optional

Example : [ "XmlPhaseLogFormatType" ]

< XmlPhaseLogFormatType > array

links
optional

Example : [ "Link" ]

< Link > array

XmlPhaseLogStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlPhaseLogStatusList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

statuses
optional

Example : [ "XmlPhaseLogStatus" ]

< XmlPhaseLogStatus > array

XmlPhaseLogView

Details of a specific Phase

Name Description Schema

display-name
optional

The human readable name of the Phase that was executed.
Example : "Execute Script Phase"

string

duration
optional

The duration of the Phase Execution.
Example : 178890402

integer (int64)

end-datetime
optional

The Date and Time when the Phase ended execution.
Example : "2019-11-22T08:17:50"

string

formattingData
optional

Additional formatting data used to format the Phase Log.
Example : "/xslt/ant/log.xsl"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

log-format
optional

The format of the Phase Log (0=TXT; 1=XML).
Example : LinkedResource

LinkedResource

message
optional

The summary message of the Phase Log.
Example : "Message"

string

phase-name
optional

The internal name of the Phase that was executed.
Example : "be.ikan.scm4all.phases.core.executeScript"

string

phase-version
optional

The version of the Phase that was executed.
Example : "5.9.0"

string

stackTrace
optional

The stack trace of the Phase Log in case of a failure.
Example : "Stack trace"

string

start-datetime
optional

The Date and Time when the Phase started execution.
Example : "2019-11-22T08:17:39"

string

status
optional

The status of the Phase Execution (0=Not Executed; 1=Success; 2=Warning; 3=Fail; 4=Run; 5=Aborted).
Example : LinkedResource

LinkedResource

XmlPhaseLogViewList

A list of Phase Logs

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

phases
optional

A paginated list of Phase Logs that may be filtered and sorted.
Example : [ "XmlPhaseLogView" ]

< XmlPhaseLogView > array

total
optional

Example : 0

integer (int32)

XmlProjectExportView

Details of an Exported Project(Project Export Resource)/Details of the input to Import a Project (Project Import Resource)

Name Description Schema

globalreferences
optional

References to Global Objects from the exported Project, like VCR, Build and Deploy Tools, User Groups, Machines, … These Objects should exist in the IKAN ALM instance when your are importing a Project.
Example : [ "XmlGlobalRefResource" ]

< XmlGlobalRefResource > array

links
optional

Example : [ "Link" ]

< Link > array

projecttree
optional

The exported Project Tree, containing Project, Project Streams, Lifecycles, Levels and all their sub elements. Will be entirely created when importing the Project.
Example : XmlProjectTreeView

XmlProjectTreeView

version
optional

IKAN ALM Version that generated the Export Project Tree. Must be identical to the version of the IKAN ALM instance where this tree will be imported.
Example : "5-9.0"

string

XmlProjectStreamStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlProjectStreamStatusList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

statuses
optional

Example : [ "XmlProjectStreamStatus" ]

< XmlProjectStreamStatus > array

XmlProjectStreamView

Details of a specific Project Stream

Name Description Schema

accept-forced-build
optional

Accept Forced Build
Example : true

boolean

archived
optional

Hidden
Example : true

boolean

buildprefix
optional

Prefix
Example : "string"

string

buildsuffix
optional

Suffix
Example : "string"

string

buildtype
optional

Build Type
Example : LinkedResource

LinkedResource

description
optional

Description
Example : "string"

string

highest-buildnumber
optional

Highest Build Number
Example : 0

integer (int32)

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

is-head
optional

Type (Head or Branch stream)
Example : true

boolean

is-tagbased
optional

Whether the stream is Tag-Based
Example : true

boolean

lifecycle
optional

The Lifecycle connected to the Project Stream
Example : ForeignKeyResource

ForeignKeyResource

lifecycle-name
optional

Lifecycle Name
Example : "string"

string

links
optional

Example : [ "Link" ]

< Link > array

locked
optional

Locked
Example : true

boolean

partial-build-tag
optional

VCR Tag in case of Tag-based Partial Build
Example : "string"

string

project
optional

The Project connected to the Project Stream
Example : ForeignKeyResource

ForeignKeyResource

project-name
optional

Project Name
Example : "string"

string

projecttype
optional

Project Type
Example : LinkedResource

LinkedResource

status
optional

Status
Example : LinkedResource

LinkedResource

tag-template
optional

Tag Template
Example : "string"

string

vcr-branch-id
optional

VCR Branch ID
Example : "string"

string

XmlProjectStreamViewList

A list of Project Streams

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

projectstreams
optional

A paginated list of Project Streams that may be filtered and sorted
Example : [ "XmlProjectStreamView" ]

< XmlProjectStreamView > array

total
optional

Example : 0

integer (int32)

XmlProjectTreeView

Name Description Schema

levels
optional

Example : [ "XmlExportableLevelView" ]

< XmlExportableLevelView > array

lifecycles
optional

Example : [ "XmlExportableLifecycleView" ]

< XmlExportableLifecycleView > array

links
optional

Example : [ "Link" ]

< Link > array

project
optional

Example : XmlExportableProjectView

XmlExportableProjectView

projectstreams
optional

Example : [ "XmlExportableProjectStreamView" ]

< XmlExportableProjectStreamView > array

XmlProjectType

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlProjectTypeList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

projecttypes
optional

Example : [ "XmlProjectType" ]

< XmlProjectType > array

XmlProjectView

Details of a specific Project

Name Description Schema

admingroup
optional

Admin Access
Example : ForeignKeyResource

ForeignKeyResource

archived
optional

Hidden
Example : true

boolean

buildscript
optional

Build Script
Example : "build.xml"

string

deployscript
optional

Deploy Script
Example : "deploy.xml"

string

description
optional

Description
Example : "description"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

issuetrackingsystem
optional

Issue Tracking System
Example : ForeignKeyResource

ForeignKeyResource

links
optional

Example : [ "Link" ]

< Link > array

locked
optional

Locked
Example : true

boolean

name
optional

Name
Example : "name"

string

projecttype
optional

Project Type
Example : LinkedResource

LinkedResource

usergroup
optional

User Access
Example : ForeignKeyResource

ForeignKeyResource

vcr
optional

VCR
Example : ForeignKeyResource

ForeignKeyResource

vcr-projectname
optional

VCR Project Name
Example : "Customers"

string

XmlProjectViewList

A list of Projects

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

projects
optional

A paginated list of Projects that may be filtered and sorted
Example : [ "XmlProjectView" ]

< XmlProjectView > array

total
optional

Example : 0

integer (int32)

XmlRepositoryLayout

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlRepositoryLayoutList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

repository-layouts
optional

Example : [ "XmlRepositoryLayout" ]

< XmlRepositoryLayout > array

XmlServerStatus

Name Description Schema

id
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

text
optional

Example : "string"

string

XmlServerStatusList

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

serverstatuses
optional

Example : [ "XmlServerStatus" ]

< XmlServerStatus > array

XmlSvnView

Details of a specific Subversion Repository

Name Description Schema

command-path
optional

Command Path
Example : "c:/vcrs/svn/bin"

string

description
optional

Description
Example : "description"

string

fetch-meta-properties
optional

Whether to fetch the SVN Meta Properties or not
Example : true

boolean

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Name
Example : "SVNRepository"

string

password
optional

Password
Example : "**"

string

repository-layout
optional

Repository Layout
Example : LinkedResource

LinkedResource

repository-url
optional

Repository URL
Example : "file:///C:/almdemo/repository/svn/"

string

tags-directory
optional

Tags Directory
Example : "tags"

string

timeout
optional

Time-Out (seconds)
Minimum value : 30
Maximum value : 3600
Example : 30

integer (int32)

trunk-directory
optional

Trunk Directory
Example : "trunk"

string

type
optional

Repository Type (svn)
Example : "svn"

string

user-id
optional

User ID
Example : "svnuser"

string

XmlSvnViewList

A list of Subversion Repositories

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

subversions
optional

A paginated list of Subversion Repositories that may be filtered and sorted
Example : [ "XmlSvnView" ]

< XmlSvnView > array

total
optional

Example : 0

integer (int32)

XmlUserGroupView

Details of a specific UserGroup

Name Description Schema

description
optional

Description
Example : "description"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

name
optional

Name
Example : "ALM Administrator"

string

type
optional

Whether the User Group is Internal(0) or External(1)
Example : 0

integer (int32)

XmlUserGroupViewList

A list of User Groups

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

usergroups
optional

A paginated list of User Groups that may be filtered and sorted
Example : [ "XmlUserGroupView" ]

< XmlUserGroupView > array

XmlUserView

Details of a specific User

Name Description Schema

archived
optional

Whether the User is Archived or not
Example : true

boolean

browserID
optional

The Browser ID of a connected User
Example : "string"

string

description
optional

Description
Example : "description"

string

email-address
optional

E-mail Address
Example : "user@example.com"

string

id
optional

The Uniform Resource Name (urn) of the retrieved object.
Example : "urn:alm:viewName:1:1"

string

links
optional

Example : [ "Link" ]

< Link > array

locale
optional

Locale
Example : "en"

string

location
optional

Location
Example : "UserHouse"

string

login-date
optional

The Login Time of a connected User
Example : "1574353976919"

string (date-time)

login-hostIP
optional

The IP Address of a connected User
Example : "0:0:0:0:0:0:0:1"

string

login-hostname
optional

The Hostname of a connected User
Example : "localhost"

string

mobile-number
optional

Mobile Number
Example : "+32 (0)11 22 33 44"

string

name
optional

Name
Example : "User"

string

reserved
optional

Whether the User is Reserved or not
Example : true

boolean

tel-number
optional

Phone Number
Example : "+32 (0)11 22 33 44"

string

user-id
optional

User ID
Example : "user"

string

XmlUserViewList

A list of Users

Name Description Schema

count
optional

Example : 0

integer (int32)

links
optional

Example : [ "Link" ]

< Link > array

page
optional

Example : 0

integer (int32)

pagesize
optional

Example : 0

integer (int32)

total
optional

Example : 0

integer (int32)

users
optional

A paginated list of Users that may be filtered and sorted
Example : [ "XmlUserView" ]

< XmlUserView > array

XmlValidatedProjectImportView

Details of a Project Import Action

Name Description Schema

imported-project
optional

The imported Project, shown when import is successful.
Example : XmlExportableProjectView

XmlExportableProjectView

links
optional

Example : [ "Link" ]

< Link > array

validation-errors
optional

Shows any validation errors that occurred during the validation stage or the actual import.
Example : { "string" : "string" }

< string, string > map

validation-report
optional

The Validation Report describing the result of the 3 Validation Stages (dry-run) and the Validation Import Stage (real import): * Stage One: Validation of the global references in the project tree; * Stage two: Validate whether the global references can be linked to a global object in the IKAN ALM Instance; * Stage Three: Validate whether the internal project links are correct; * Import Stage: only present when the other stages are validated, reports on the actual Project Import.
Example : [ "string" ]

< string > array