Jump to

• Request
• Response

View a Workspace by Code

get

/api/restapi/workspace/code/{workspaceCode}

This endpoint returns workspaces that meet the following requirements:

• The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.

Request

Path Parameters

• workspaceCode(required): string
  The name of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityWorkspace>

Type: array

Title: List<ApiEntityWorkspace>

Show Source

• Array of: object ApiEntityWorkspace
  Title: ApiEntityWorkspace

{
    "title":"List<ApiEntityWorkspace>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspace",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityWorkspace

Type: object

Title: ApiEntityWorkspace

Show Source

• description: string
  Maximum Length: 4000

  Summary of the workspace.
• image: image
  An image associated with the workspace.
• isProduction: boolean
  Indicates a workspace that is in production.
  All workspaces created under the Production workspace are automatically designated as production.
  This cannot be changed.
• isSysGenerated: boolean
  Indicates a workspace that was created by the system.
  System generated workspaces cannot be deleted.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of the workspace hierarchically above another workspace.
• parentWorkspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The parent workspace code of a workspace.
• securityGuid: string
  Maximum Length: 32

  The Globally Unique Identifier of the workspace.
• sequenceNumber: integer (int32)
  Determines the order of appearance of workspaces in a list.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceAutonumSettings: array workspaceAutonumSettings
  An object containing workspace autonumber settings.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceCurrencySetting: workspaceCurrencySetting
  Entity to create or update default currency and view the parent workspace currencies.
• workspaceId: integer (int64)
  The unique identifier of a workspace.
• workspaceName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of a workspace.
• workspaceSettings: array workspaceSettings
  An object containing workspace settings.

{
    "title":"ApiEntityWorkspace",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"Determines the order of appearance of workspaces in a list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"Summary of the workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of the workspace hierarchically above another workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "securityGuid":{
            "maxLength":"32",
            "type":"string",
            "description":"The Globally Unique Identifier of the workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "image":{
            "description":"An image associated with the workspace.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityWorkspaceImage"
                }
            ]
        },
        "workspaceName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"Name of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceSettings":{
            "type":"array",
            "description":"An object containing workspace settings.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceSetting",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceAutonumSettings":{
            "type":"array",
            "description":"An object containing workspace autonumber settings.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAutonumSetting",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCurrencySetting":{
            "description":"Entity to create or update default currency and view the parent workspace currencies.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityWorkspaceCurrencySetting"
                }
            ]
        },
        "parentWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The parent workspace code of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isProduction":{
            "type":"boolean",
            "description":"Indicates a workspace that is in production.  <br />All workspaces created under the Production workspace are automatically designated as production. <br />This cannot be changed.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isSysGenerated":{
            "type":"boolean",
            "description":"Indicates a workspace that was created by the system. <br />System generated workspaces cannot be deleted.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : image

An image associated with the workspace.

Match All

Show Source

• object ApiEntityWorkspaceImage
  Title: ApiEntityWorkspaceImage

  Read Only: true

{
    "description":"An image associated with the workspace.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityWorkspaceImage"
        }
    ]
}

Nested Schema : workspaceAutonumSettings

Type: array

An object containing workspace autonumber settings.

Show Source

• Array of: object ApiEntityWorkspaceAutonumSetting
  Title: ApiEntityWorkspaceAutonumSetting

{
    "type":"array",
    "description":"An object containing workspace autonumber settings.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAutonumSetting",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : workspaceCurrencySetting

Entity to create or update default currency and view the parent workspace currencies.

Match All

Show Source

• object ApiEntityWorkspaceCurrencySetting
  Title: ApiEntityWorkspaceCurrencySetting

{
    "description":"Entity to create or update default currency and view the parent workspace currencies.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityWorkspaceCurrencySetting"
        }
    ]
}

Nested Schema : workspaceSettings

Type: array

An object containing workspace settings.

Show Source

• Array of: object ApiEntityWorkspaceSetting
  Title: ApiEntityWorkspaceSetting

{
    "type":"array",
    "description":"An object containing workspace settings.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceSetting",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityWorkspaceImage

Type: object

Title: ApiEntityWorkspaceImage

Read Only: true

Show Source

• image: array image
  An image object represented in binary format.
• imageType: string
  Allowed Values: [ "PNG", "JPEG", "GIF" ]

  The file type of the image. Valid values are PNG, JPEG, and GIF.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceId: integer (int64)
  The unique identifier of the workspace that contains this image.
• workspaceImageId: integer (int64)
  The unique identifier of the image.

{
    "title":"ApiEntityWorkspaceImage",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of the workspace that contains this image.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "image":{
            "type":"array",
            "description":"An image object represented in binary format.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "format":"byte",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "imageType":{
            "type":"string",
            "description":"The file type of the image. Valid values are <b>PNG</b>, <b>JPEG</b>, and  <b>GIF</b>.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "workspaceImageId":{
            "type":"integer",
            "description":"The unique identifier of the image.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "readOnly":true,
    "exampleSetFlag":false
}

Nested Schema : image

Type: array

An image object represented in binary format.

Show Source

• Array of: string(byte)

{
    "type":"array",
    "description":"An image object represented in binary format.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "format":"byte",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityWorkspaceAutonumSetting

Type: object

Title: ApiEntityWorkspaceAutonumSetting

Show Source

• area: string
  Allowed Values: [ "IDEA", "PROGRAM", "PROJECT", "ACTIVITY", "SCHEDULE_SCENARIO", "ACTIVITY_ASSIGNMENT", "WBS", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGE", "PROGRAM_BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "PROG_RISK", "ACTUALS", "WORK_MANAGER_TASK", "CONSTRAINT", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM", "RESOURCE" ]

  Identifies the type of object used for auto numbering.
• autonumId: integer (int64)
  The unique identifier of an auto numbering sequence.
• increment: integer (int32)
  Minimum Value: 1

  Maximum Value: 99999

  Number by which the auto numbering suffix is incremented.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• name: string
  Maximum Length: 50

  Name of the auto numbering sequence.
• prefix: string
  Minimum Length: 0

  Maximum Length: 20

  Initial characters for the workspace auto numbering sequence.
• suffix: string
  Minimum Length: 1

  Maximum Length: 20

  The first number in the workspace auto numbering sequence.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityWorkspaceAutonumSetting",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":"50",
            "type":"string",
            "description":"Name of the auto numbering sequence.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "prefix":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string",
            "description":"Initial characters for the workspace auto numbering sequence.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "suffix":{
            "maxLength":"20",
            "minLength":"1",
            "type":"string",
            "description":"The first number in the workspace auto numbering sequence.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "increment":{
            "maximum":"99999",
            "minimum":"1",
            "type":"integer",
            "description":"Number by which the auto numbering suffix is incremented.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "area":{
            "type":"string",
            "description":"Identifies the type of object used for auto numbering.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IDEA",
                "PROGRAM",
                "PROJECT",
                "ACTIVITY",
                "SCHEDULE_SCENARIO",
                "ACTIVITY_ASSIGNMENT",
                "WBS",
                "SCOPE_ITEM",
                "SCOPE_ASSIGNMENT",
                "CHANGE_ITEM",
                "WORK_PACKAGE",
                "CHANGE_REQUEST",
                "CONTRACT",
                "COMMITMENT",
                "BUDGET_CHANGE",
                "BUDGET_TRANSFER",
                "PROGRAM_BUDGET",
                "PROGRAM_BUDGET_CHANGE",
                "PROGRAM_BUDGET_TRANSFER",
                "CHANGE_ORDER",
                "POTENTIAL_CHANGE_ORDER",
                "PAYMENT_APPLICATION",
                "RISK",
                "PROG_RISK",
                "ACTUALS",
                "WORK_MANAGER_TASK",
                "CONSTRAINT",
                "SUBMITTAL",
                "CHANGE_EVENT",
                "RFI",
                "CUSTOM_LOGS_ITEM",
                "RESOURCE"
            ]
        },
        "autonumId":{
            "type":"integer",
            "description":"The unique identifier of an auto numbering sequence.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkspaceCurrencySetting

Type: object

Title: ApiEntityWorkspaceCurrencySetting

Show Source

• defaultCurrencyExchangeRate: number
  The exchange rate of the workspace default currency.
• defaultCurrencyId: integer (int64)
  The workspace default currency that is selected on the workspace.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCurrency1ExchangeRate: number
  The exchange rate of the default currency of the first workspace in the hierarchy.
• workspaceCurrency1Id: integer (int64)
  The system-generated identifier of the default currency of the first workspace in the hierarchy.
• workspaceCurrency2ExchangeRate: number
  The exchange rate of the default currency of the second workspace in the hierarchy.
• workspaceCurrency2Id: integer (int64)
  The system-generated identifier of the default currency of the second workspace in the hierarchy.
• workspaceCurrency3ExchangeRate: number
  The exchange rate of the default currency of the third workspace in the hierarchy.
• workspaceCurrency3Id: integer (int64)
  The system-generated identifier of the default currency of the third workspace in the hierarchy.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityWorkspaceCurrencySetting",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCurrency1Id":{
            "type":"integer",
            "description":"The system-generated identifier of the default currency of the first workspace in the hierarchy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCurrency2Id":{
            "type":"integer",
            "description":"The system-generated identifier of the default currency of the second workspace in the hierarchy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCurrency3Id":{
            "type":"integer",
            "description":"The system-generated identifier of the default currency of the third workspace in the hierarchy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "defaultCurrencyId":{
            "type":"integer",
            "description":"The workspace default currency that is selected on the workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "defaultCurrencyExchangeRate":{
            "type":"number",
            "description":"The exchange rate of the workspace default currency.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "workspaceCurrency1ExchangeRate":{
            "type":"number",
            "description":"The exchange rate of the default currency of the first workspace in the hierarchy.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "workspaceCurrency2ExchangeRate":{
            "type":"number",
            "description":"The exchange rate of the default currency of the second workspace in the hierarchy.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "workspaceCurrency3ExchangeRate":{
            "type":"number",
            "description":"The exchange rate of the default currency of the third workspace in the hierarchy.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkspaceSetting

Type: object

Title: ApiEntityWorkspaceSetting

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• settingName: string
  Minimum Length: 0

  Maximum Length: 255

  Name of a workspace setting.
• settingValue: string
  Minimum Length: 0

  Maximum Length: 255

  Value of a workspace setting.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceId: integer (int64)
  The unique identifier of a workspace setting.
• workspaceSettingId: integer (int64)
  The unique identifier of a workspace setting.

{
    "title":"ApiEntityWorkspaceSetting",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace setting.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "settingName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Name of a workspace setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "settingValue":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Value of a workspace setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceSettingId":{
            "type":"integer",
            "description":"The unique identifier of a workspace setting.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested workspace does not exist or you do not have access to it.

Back to Top