• [0]: object ApiEntityWorkspace

{
    "title":"List<ApiEntityWorkspace>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityWorkspace"
    }
}

• description(optional): string
  Summary of the workspace.
• image(optional): object ApiEntityWorkspaceImage
• isProduction(optional): boolean
  Read Only: true

  Indicates a workspace that is in production.
  All workspaces created under the Production workspace are automatically designated as production.
  This cannot be changed.
• isSysGenerated(optional): boolean
  Read Only: true

  Indicates a workspace that was created by the system.
  System generated workspaces cannot be deleted.
• link(optional): string(url)
  Read Only: true
• parentWorkspace(optional): integer(int64)
  The unique identifier of the workspace hierarchically above another workspace.
• securityGuid(optional): string
  The Globally Unique Identifier of the workspace.
• sequenceNumber(optional): integer(int32)
  Determines the order of appearance of workspaces in a list.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspaceAutonumSettings(optional): array workspaceAutonumSettings
  Unique Items Required: true

  An object containing workspace autonumber settings.
• workspaceCode(optional): string
  Workspace Code.
• workspaceId(optional): integer(int64)
  The unique identifier of a workspace.
• workspaceName(optional): string
  Name of a workspace.
• workspaceSettings(optional): array workspaceSettings
  Unique Items Required: true

  An object containing workspace settings.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace."
        },
        "description":{
            "type":"string",
            "description":"Summary of the workspace."
        },
        "workspaceName":{
            "type":"string",
            "description":"Name of a workspace."
        },
        "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.",
            "readOnly":true
        },
        "workspaceCode":{
            "type":"string",
            "description":"Workspace Code."
        },
        "image":{
            "description":"An image associated with the workspace.",
            "$ref":"#/definitions/ApiEntityWorkspaceImage"
        },
        "securityGuid":{
            "type":"string",
            "description":"The Globally Unique Identifier of the workspace."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"Determines the order of appearance of workspaces in a list."
        },
        "workspaceSettings":{
            "type":"array",
            "description":"An object containing workspace settings.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityWorkspaceSetting"
            }
        },
        "workspaceAutonumSettings":{
            "type":"array",
            "description":"An object containing workspace autonumber settings.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityWorkspaceAutonumSetting"
            }
        },
        "parentWorkspace":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the workspace hierarchically above another workspace."
        },
        "isSysGenerated":{
            "type":"boolean",
            "description":"Indicates a workspace that was created by the system. <br />System generated workspaces cannot be deleted.",
            "readOnly":true
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• image(optional): 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(optional): string(url)
  Read Only: true
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspaceId: integer(int64)
  The unique identifier of the workspace that contains this image.
• workspaceImageId: integer(int64)
  The unique identifier of the image.

{
    "type":"object",
    "required":[
        "imageType",
        "workspaceId",
        "workspaceImageId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the workspace that contains this image."
        },
        "image":{
            "type":"array",
            "description":"An image object represented in binary format.",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "imageType":{
            "type":"string",
            "description":"The file type of the image. Valid values are <b>PNG</b>, <b>JPEG</b>, and  <b>GIF</b>.",
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "workspaceImageId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the image."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• [0]: object ApiEntityWorkspaceAutonumSetting

{
    "type":"array",
    "description":"An object containing workspace autonumber settings.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityWorkspaceAutonumSetting"
    }
}

• [0]: object ApiEntityWorkspaceSetting

{
    "type":"array",
    "description":"An object containing workspace settings.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityWorkspaceSetting"
    }
}

• [0]: string(byte)

{
    "type":"array",
    "description":"An image object represented in binary format.",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

• area(optional): string
  Allowed Values: [ "IDEA", "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER", "CHANGE_ORDER", "POTENTIAL_CHANGE_ORDER", "PAYMENT_APPLICATION", "RISK", "ACTUALS", "WORK_MANAGER_TASK", "SUBMITTAL", "CHANGE_EVENT", "RFI", "CUSTOM_LOGS_ITEM" ]

  Identifies the type of object used for auto numbering.
• autonumId(optional): integer(int64)
  The unique identifier of an auto numbering sequence.
• link(optional): string(url)
  Read Only: true
• name(optional): string
  Name of the auto numbering sequence.
• prefix(optional): string
  Initial characters for the workspace auto numbering sequence.
• suffix(optional): string
  The first number in the workspace auto numbering sequence.
• suffixIncrement(optional): integer(int32)
  Number by which the auto numbering suffix is incremented.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspaceId(optional): integer(int64)
  The unique identifier of a workspace.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the auto numbering sequence."
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace."
        },
        "prefix":{
            "type":"string",
            "description":"Initial characters for the workspace auto numbering sequence."
        },
        "suffix":{
            "type":"string",
            "description":"The first number in the workspace auto numbering sequence."
        },
        "area":{
            "type":"string",
            "description":"Identifies the type of object used for auto numbering.",
            "enum":[
                "IDEA",
                "ACTIVITY",
                "ACTIVITY_ASSIGNMENT",
                "SCOPE_ITEM",
                "SCOPE_ASSIGNMENT",
                "CHANGE_ITEM",
                "WORK_PACKAGE",
                "CHANGE_REQUEST",
                "CONTRACT",
                "COMMITMENT",
                "BUDGET_CHANGE",
                "BUDGET_TRANSFER",
                "CHANGE_ORDER",
                "POTENTIAL_CHANGE_ORDER",
                "PAYMENT_APPLICATION",
                "RISK",
                "ACTUALS",
                "WORK_MANAGER_TASK",
                "SUBMITTAL",
                "CHANGE_EVENT",
                "RFI",
                "CUSTOM_LOGS_ITEM"
            ]
        },
        "autonumId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of an auto numbering sequence."
        },
        "suffixIncrement":{
            "type":"integer",
            "format":"int32",
            "description":"Number by which the auto numbering suffix is incremented."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• link(optional): string(url)
  Read Only: true
• settingName: string
  Name of a workspace setting.
• settingValue: string
  Value of a workspace setting.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspaceId: integer(int64)
  The unique identifier of a workspace setting.
• workspaceSettingId: integer(int64)
  The unique identifier of a workspace setting.

{
    "type":"object",
    "required":[
        "settingName",
        "settingValue",
        "workspaceId",
        "workspaceSettingId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace setting."
        },
        "settingValue":{
            "type":"string",
            "description":"Value of a workspace setting."
        },
        "settingName":{
            "type":"string",
            "description":"Name of a workspace setting."
        },
        "workspaceSettingId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace setting."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}