Jump to

• Request
• Response

Batch Sync Calendars

post

/api/restapi/calendar/syncBatch

Send a request to this endpoint to create or update one or more calendars.

Request

Header Parameters

• singleTransaction:
  Enabling this boolean flag will fail the request if an error occurs while processing any calendar sent as part of the request.
  Allowed Values: [ "true", "false" ]

  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityCalendarInput>

Type: array

Title: List<ApiEntityCalendarInput>

Show Source

• Array of: object ApiEntityCalendarInput
  Title: ApiEntityCalendarInput

  This entity represents a Calendar object, a unique Calendar object can be identified by the following combinations of the fields.

  • calendarId
  • calendarCode,workspaceId
  • calendarCode,workspaceCode
  • calendarCode,projectId
  • calendarCode,projectCode,workspaceCode
  • calendarCode,projectCode,workspaceId

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

Nested Schema : ApiEntityCalendarInput

Type: object

Title: ApiEntityCalendarInput

This entity represents a Calendar object, a unique Calendar object can be identified by the following combinations of the fields.

• calendarId
• calendarCode,workspaceId
• calendarCode,workspaceCode
• calendarCode,projectId
• calendarCode,projectCode,workspaceCode
• calendarCode,projectCode,workspaceId

Show Source

• associationType: string
  Read Only: true

  Allowed Values: [ "OWNED", "INHERITED" ]

  Deprecated. As of 24.4.
  The type of association in the relationship between the calendar and the workspace. Possible values are Owned and Inherited.
• calendarCode: string
  Minimum Length: 0

  Maximum Length: 255

  The unique code for the calendar.
• calendarExceptions: array calendarExceptions
  Defines exceptions to the specified calendar.
• calendarId: integer (int64)
  The unique identifier for the calendar.
• calendarName(required): string
  Minimum Length: 0

  Maximum Length: 255

  The name of the calendar.
• dayHourCount: number (double)
  The number of hours in a day.
• holiday: integer (int64)
  The holiday list assigned to the calendar.
• holidayMoveType: string
  Allowed Values: [ "NONE", "FORWARD", "BACKWARD", "CLOSEST_WORK_DAY" ]

  Specifies a holiday within calendar work time.
• isAssignableToProject: boolean
  Indicates whether or not the calendar can be assigned to a project.
• isAssignableToResource: boolean
  Indicates whether or not the calendar can be assigned to a resource.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.4.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• monthHourCount: number (double)
  The number of hours in a month.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  Specifies how a workspace calendar is shared across child workspaces.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.4.
  Date when the record was last updated.
• weekHourCount: number (double)
  The number of hours in a week.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
• workTimeFriday(required): string
  Maximum Length: 48

  The working time for Friday.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000
• workTimeMonday(required): string
  Maximum Length: 48

  The working time for Monday.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000
• workTimeSaturday(required): string
  Maximum Length: 48

  The working time for Saturday.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000
• workTimeSunday(required): string
  Maximum Length: 48

  The working time for Sunday.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000
• workTimeThursday(required): string
  Maximum Length: 48

  The working time for Thursday.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000
• workTimeTuesday(required): string
  Maximum Length: 48

  The working time for Tuesday.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000
• workTimeWednesday(required): string
  Maximum Length: 48

  The working time for Wednesday.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000
• yearHourCount: number (double)
  The number of hours in a year.

{
    "title":"ApiEntityCalendarInput",
    "required":[
        "calendarName",
        "workTimeFriday",
        "workTimeMonday",
        "workTimeSaturday",
        "workTimeSunday",
        "workTimeThursday",
        "workTimeTuesday",
        "workTimeWednesday",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>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,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarCode":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The unique code for the calendar.",
            "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 for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "isAssignableToResource":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a resource.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"Specifies how a workspace calendar is shared across child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The type of association in the relationship between the calendar and the workspace. Possible values are Owned and Inherited.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "calendarExceptions":{
            "type":"array",
            "description":"Defines exceptions to the specified calendar.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCalendarExceptionInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workTimeSunday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Sunday. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isAssignableToProject":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a project.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "workTimeMonday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Monday. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workTimeTuesday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Tuesday. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workTimeWednesday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Wednesday. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workTimeThursday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Thursday. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workTimeFriday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Friday. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workTimeSaturday":{
            "maxLength":"48",
            "type":"string",
            "description":"The working time for Saturday. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "monthHourCount":{
            "type":"number",
            "description":"The number of hours in a month.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "dayHourCount":{
            "type":"number",
            "description":"The number of hours in a day.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "yearHourCount":{
            "type":"number",
            "description":"The number of hours in a year.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "weekHourCount":{
            "type":"number",
            "description":"The number of hours in a week.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "holidayMoveType":{
            "type":"string",
            "description":"Specifies a holiday within calendar work time.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "FORWARD",
                "BACKWARD",
                "CLOSEST_WORK_DAY"
            ]
        },
        "holiday":{
            "type":"integer",
            "description":"The holiday list assigned to the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a Calendar object, a unique Calendar object can be identified by the following combinations of the fields.<ul><li>calendarId</li><li>calendarCode,workspaceId</li><li>calendarCode,workspaceCode</li><li>calendarCode,projectId</li><li>calendarCode,projectCode,workspaceCode</li><li>calendarCode,projectCode,workspaceId</li>",
    "exampleSetFlag":false
}

Nested Schema : calendarExceptions

Type: array

Defines exceptions to the specified calendar.

Show Source

• Array of: object ApiEntityCalendarExceptionInput
  Title: ApiEntityCalendarExceptionInput

{
    "type":"array",
    "description":"Defines exceptions to the specified calendar.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCalendarExceptionInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCalendarExceptionInput

Type: object

Title: ApiEntityCalendarExceptionInput

Show Source

• calendarCode: string
  Read Only: true

  Minimum Length: 0

  Maximum Length: 255

  Deprecated. As of 24.4.
  The unique code for the calendar.
• calendarExceptionId: integer (int64)
  The unique identifier for the calendar exception.
• calendarId(required): integer (int64)
  The unique identifier for the calendar.
• exceptionDate(required): string (date-time)
  The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar.
• exceptionName: string
  Maximum Length: 60

  The name of the exception for the calendar.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.4.
  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

  Deprecated. As of 24.4.
  Date when the record was last updated.
• workspaceCode: string
  Read Only: true

  Minimum Length: 0

  Maximum Length: 60

  Deprecated. As of 24.4.
  The user-specified identifier of a workspace.
• workTime: string
  Maximum Length: 4000

  Work time that is non-standard.
  The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.
  For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM.
  000000000000000000111111111111111100000000000000

{
    "title":"ApiEntityCalendarExceptionInput",
    "required":[
        "calendarId",
        "exceptionDate"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>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,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the exception for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarCode":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The unique code for the calendar.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The user-specified identifier of a workspace.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionDate":{
            "type":"string",
            "description":"The date that is marked as an exception. An exception is a change to the regularly scheduled time in the calendar.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workTime":{
            "maxLength":"4000",
            "type":"string",
            "description":"Work time that is non-standard. </br>The value is a 48 character string, which can either be 0 to indicate non-work time or 1 to indicate work time. Each character in this 48 character string corresponds to a 30 minute slot available in a day. Two slots per hour multiplied by 24 hours equals 48 characters.</br> For example, the 1's in the following string indicate that work time for the day is 9 AM to 5 PM. </br>000000000000000000111111111111111100000000000000",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarExceptionId":{
            "type":"integer",
            "description":"The unique identifier for the calendar exception.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Create or Update Calendar for a Project Create or Update Calendar for a Workspace

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : List<ApiEntitySyncApiResponse>

Type: array

Title: List<ApiEntitySyncApiResponse>

Show Source

• Array of: object ApiEntitySyncApiResponse
  Title: ApiEntitySyncApiResponse

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

Nested Schema : ApiEntitySyncApiResponse

Type: object

Title: ApiEntitySyncApiResponse

Show Source

• identifier: object identifier
  The unique identifier of the supported object returned based on the user input.
  This field can return any of the following entities determined based on the object for which the API call is invoked.
  Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.
• 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.
• message: string
  Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
• statusCode: integer (int32)
  The response code representing the state of the API operation.

{
    "title":"ApiEntitySyncApiResponse",
    "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"
            ]
        },
        "message":{
            "type":"string",
            "description":"Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "identifier":{
            "type":"object",
            "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.",
            "exampleSetFlag":false,
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ConstraintIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CBSSheetSegmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CBSTemplateSegmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeAssignmentActualsTimePhasedDataIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeAssignmentInstalledTimePhasedDataIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceWorkRateIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ReasonIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/WorkManagerTaskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ChangeRequestIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeItemAssignmentActivityIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskScoreTypeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskMatrixIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectRiskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramRiskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ActivityRiskIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskMitigationIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramRiskMitigationIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramRiskWeatherPeriodIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/HolidayGroupIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RiskWeatherPeriodIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/PortfolioIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/PortfolioMeasureIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/EntityReferenceIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/PortfolioMeasureManualValueIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CustomLogItemIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectRankIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectDependencyIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/LocationIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/MeasureIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/MeasureThresholdIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ReportCycleIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/UnitsOfMeasureIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/WorkspaceIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ApplicationUserGroupIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CalendarIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CodeTypeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CodeValueIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CostCategoryIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CurveIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/DocumentFolderStructureTemplateIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/IdeaIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/OfficeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectCompanyIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceDemandIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectBudgetChangeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectBudgetTransferIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectResourceWorkRateIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectActualsLineItemIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectActualsIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProjectBudgetItemIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/StrategyIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/StrategyTypeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RuleOfCreditIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceRoleAssignmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/BudgetPlanningScenarioIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ScopeAssignmentPlannedTimePhasedDataIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramBudgetTransferIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramBudgetChangeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ActivityIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/AssignmentIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/RelationshipIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/FundActualIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ProgramBudgetItemIdentifier",
                    "exampleSetFlag":false
                }
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : identifier

Type: object

The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.

Match One Schema

Show Source

• object ConstraintIdentifier
  Title: ConstraintIdentifier
• object CBSSheetSegmentIdentifier
  Title: CBSSheetSegmentIdentifier
• object CBSTemplateSegmentIdentifier
  Title: CBSTemplateSegmentIdentifier
• object ScopeAssignmentActualsTimePhasedDataIdentifier
  Title: ScopeAssignmentActualsTimePhasedDataIdentifier
• object ScopeAssignmentInstalledTimePhasedDataIdentifier
  Title: ScopeAssignmentInstalledTimePhasedDataIdentifier
• object ResourceWorkRateIdentifier
  Title: ResourceWorkRateIdentifier
• object ReasonIdentifier
  Title: ReasonIdentifier
• object WorkManagerTaskIdentifier
  Title: WorkManagerTaskIdentifier
• object ChangeRequestIdentifier
  Title: ChangeRequestIdentifier
• object ScopeItemAssignmentActivityIdentifier
  Title: ScopeItemAssignmentActivityIdentifier
• object RiskScoreTypeIdentifier
  Title: RiskScoreTypeIdentifier
• object RiskMatrixIdentifier
  Title: RiskMatrixIdentifier
• object ProjectRiskIdentifier
  Title: ProjectRiskIdentifier
• object ProgramRiskIdentifier
  Title: ProgramRiskIdentifier
• object ActivityRiskIdentifier
  Title: ActivityRiskIdentifier
• object RiskMitigationIdentifier
  Title: RiskMitigationIdentifier
• object ProgramRiskMitigationIdentifier
  Title: ProgramRiskMitigationIdentifier
• object ProgramRiskWeatherPeriodIdentifier
  Title: ProgramRiskWeatherPeriodIdentifier
• object HolidayGroupIdentifier
  Title: HolidayGroupIdentifier
• object RiskWeatherPeriodIdentifier
  Title: RiskWeatherPeriodIdentifier
• object PortfolioIdentifier
  Title: PortfolioIdentifier
• object PortfolioMeasureIdentifier
  Title: PortfolioMeasureIdentifier
• object EntityReferenceIdentifier
  Title: EntityReferenceIdentifier
• object PortfolioMeasureManualValueIdentifier
  Title: PortfolioMeasureManualValueIdentifier
• object CustomLogTypeObjectIdentifier
  Title: CustomLogTypeObjectIdentifier
• object CustomLogItemIdentifier
  Title: CustomLogItemIdentifier
• object ProjectRankIdentifier
  Title: ProjectRankIdentifier
• object ProjectDependencyIdentifier
  Title: ProjectDependencyIdentifier
• object LocationIdentifier
  Title: LocationIdentifier
• object MeasureIdentifier
  Title: MeasureIdentifier
• object MeasureThresholdIdentifier
  Title: MeasureThresholdIdentifier
• object ReportCycleIdentifier
  Title: ReportCycleIdentifier
• object UnitsOfMeasureIdentifier
  Title: UnitsOfMeasureIdentifier
• object WorkspaceIdentifier
  Title: WorkspaceIdentifier
• object ApplicationUserGroupIdentifier
  Title: ApplicationUserGroupIdentifier
• object CalendarIdentifier
  Title: CalendarIdentifier
• object CodeTypeIdentifier
  Title: CodeTypeIdentifier
• object CodeValueIdentifier
  Title: CodeValueIdentifier
• object CostCategoryIdentifier
  Title: CostCategoryIdentifier
• object CurveIdentifier
  Title: CurveIdentifier
• object DocumentFolderStructureTemplateIdentifier
  Title: DocumentFolderStructureTemplateIdentifier
• object IdeaIdentifier
  Title: IdeaIdentifier
• object OfficeIdentifier
  Title: OfficeIdentifier
• object ProjectCompanyIdentifier
  Title: ProjectCompanyIdentifier
• object ResourceDemandIdentifier
  Title: ResourceDemandIdentifier
• object ProjectBudgetChangeIdentifier
  Title: ProjectBudgetChangeIdentifier
• object ProjectBudgetTransferIdentifier
  Title: ProjectBudgetTransferIdentifier
• object ProjectResourceWorkRateIdentifier
  Title: ProjectResourceWorkRateIdentifier
• object ProjectActualsLineItemIdentifier
  Title: ProjectActualsLineItemIdentifier
• object ProjectActualsIdentifier
  Title: ProjectActualsIdentifier
• object ProjectBudgetItemIdentifier
  Title: ProjectBudgetItemIdentifier
• object ProgramIdentifier
  Title: ProgramIdentifier
• object StrategyIdentifier
  Title: StrategyIdentifier
• object StrategyTypeIdentifier
  Title: StrategyTypeIdentifier
• object RuleOfCreditIdentifier
  Title: RuleOfCreditIdentifier
• object ResourceRoleAssignmentIdentifier
  Title: ResourceRoleAssignmentIdentifier
• object BudgetPlanningScenarioIdentifier
  Title: BudgetPlanningScenarioIdentifier
• object ScopeAssignmentPlannedTimePhasedDataIdentifier
  Title: ScopeAssignmentPlannedTimePhasedDataIdentifier
• object ProgramBudgetTransferIdentifier
  Title: ProgramBudgetTransferIdentifier
• object ProgramBudgetChangeIdentifier
  Title: ProgramBudgetChangeIdentifier
• object ActivityIdentifier
  Title: ActivityIdentifier
• object AssignmentIdentifier
  Title: AssignmentIdentifier
• object RelationshipIdentifier
  Title: RelationshipIdentifier
• object FundActualIdentifier
  Title: FundActualIdentifier
• object ProgramBudgetItemIdentifier
  Title: ProgramBudgetItemIdentifier

{
    "type":"object",
    "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> RiskScoreTypeIdentifier is returned when Batch Sync Risk Score Types API is invoked.",
    "exampleSetFlag":false,
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConstraintIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CBSSheetSegmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CBSTemplateSegmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeAssignmentActualsTimePhasedDataIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeAssignmentInstalledTimePhasedDataIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceWorkRateIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ReasonIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/WorkManagerTaskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ChangeRequestIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeItemAssignmentActivityIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskScoreTypeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskMatrixIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectRiskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramRiskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ActivityRiskIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskMitigationIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramRiskMitigationIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramRiskWeatherPeriodIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/HolidayGroupIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RiskWeatherPeriodIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/PortfolioIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/PortfolioMeasureIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/EntityReferenceIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/PortfolioMeasureManualValueIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CustomLogItemIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectRankIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectDependencyIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/LocationIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/MeasureIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/MeasureThresholdIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ReportCycleIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/UnitsOfMeasureIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/WorkspaceIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ApplicationUserGroupIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CalendarIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CodeTypeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CodeValueIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CostCategoryIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CurveIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/DocumentFolderStructureTemplateIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/IdeaIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/OfficeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectCompanyIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceDemandIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectBudgetChangeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectBudgetTransferIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectResourceWorkRateIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectActualsLineItemIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectActualsIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProjectBudgetItemIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/StrategyIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/StrategyTypeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RuleOfCreditIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceRoleAssignmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/BudgetPlanningScenarioIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ScopeAssignmentPlannedTimePhasedDataIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramBudgetTransferIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramBudgetChangeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ActivityIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/AssignmentIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/RelationshipIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/FundActualIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ProgramBudgetItemIdentifier",
            "exampleSetFlag":false
        }
    ]
}

Nested Schema : ConstraintIdentifier

Type: object

Title: ConstraintIdentifier

Show Source

• constraintCode(required): string
  The user specified identifier for a constraint.
• constraintId: integer (int64)
  The unique identifier of a constraint.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ConstraintIdentifier",
    "required":[
        "constraintCode"
    ],
    "type":"object",
    "properties":{
        "constraintId":{
            "type":"integer",
            "description":"The unique identifier of a constraint.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "constraintCode":{
            "type":"string",
            "description":"The user specified identifier for a constraint.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CBSSheetSegmentIdentifier

Type: object

Title: CBSSheetSegmentIdentifier

Show Source

• cbsSheetSegmentId: integer (int64)
  The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• segmentDefinitionName(required): string
  Maximum Length: 255

  The name of the level of the cost breakdown structure segment definition.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CBSSheetSegmentIdentifier",
    "required":[
        "segmentDefinitionName"
    ],
    "type":"object",
    "properties":{
        "cbsSheetSegmentId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost sheet segment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "segmentDefinitionName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the level of the cost breakdown structure segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CBSTemplateSegmentIdentifier

Type: object

Title: CBSTemplateSegmentIdentifier

Show Source

• cbsTemplateSegmentId: integer (int64)
  The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.
• segmentDefinitionName(required): string
  Maximum Length: 255

  The name of the CBS segment.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CBSTemplateSegmentIdentifier",
    "required":[
        "segmentDefinitionName"
    ],
    "type":"object",
    "properties":{
        "segmentDefinitionName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the CBS segment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cbsTemplateSegmentId":{
            "type":"integer",
            "description":"The unique identifier for the CBS segment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeAssignmentActualsTimePhasedDataIdentifier

Type: object

Title: ScopeAssignmentActualsTimePhasedDataIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentActualsTimePhasedDataId: integer (int64)
  The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeAssignmentActualsTimePhasedDataIdentifier",
    "type":"object",
    "properties":{
        "scopeAssignmentActualsTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope actuals time phased data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeAssignmentInstalledTimePhasedDataIdentifier

Type: object

Title: ScopeAssignmentInstalledTimePhasedDataIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentInstalledTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeAssignmentInstalledTimePhasedDataIdentifier",
    "type":"object",
    "properties":{
        "scopeItemAssignCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeAssignmentInstalledTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceWorkRateIdentifier

Type: object

Title: ResourceWorkRateIdentifier

Show Source

• effectiveStartDate: string (date-time)
  Date that the corresponding units/time period and rates go into effect for the resource or role.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• resourceWorkRateId: integer (int64)
  The system-generated identifier of the work rate.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.
• workspaceResourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.

{
    "title":"ResourceWorkRateIdentifier",
    "type":"object",
    "properties":{
        "effectiveStartDate":{
            "type":"string",
            "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceWorkRateId":{
            "type":"integer",
            "description":"The system-generated identifier of the work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceResourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ReasonIdentifier

Type: object

Title: ReasonIdentifier

Show Source

• reasonId: integer (int64)
  The unique identifier of a reason.
• reasonName: string
  Maximum Length: 255

  The name of the reason for recommitting to a task.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ReasonIdentifier",
    "type":"object",
    "properties":{
        "reasonId":{
            "type":"integer",
            "description":"The unique identifier of a reason.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reasonName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the reason for recommitting to a task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : WorkManagerTaskIdentifier

Type: object

Title: WorkManagerTaskIdentifier

Show Source

• itemCode: string
  Maximum Length: 60

  The user-specified unique identifier assigned to the task.
• project: integer (int64)
  The unique identifier for the project.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workManagerTaskId: integer (int64)
  The unique identifier for the resource or role.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"WorkManagerTaskIdentifier",
    "type":"object",
    "properties":{
        "project":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier assigned to the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workManagerTaskId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ChangeRequestIdentifier

Type: object

Title: ChangeRequestIdentifier

Show Source

• changeRequestCode: string
  Maximum Length: 60

  The user-specified unique identifier of the change request.
• changeRequestId: integer (int64)
  The unique identifier of the change request.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ChangeRequestIdentifier",
    "type":"object",
    "properties":{
        "changeRequestId":{
            "type":"integer",
            "description":"The unique identifier of the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "changeRequestCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier of the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeItemAssignmentActivityIdentifier

Type: object

Title: ScopeItemAssignmentActivityIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeItemAssignmentActivityId: integer (int64)
  The system-generated identifier of a scope item.
• scopeItemAssignmentCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• scopeItemCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeItemAssignmentActivityIdentifier",
    "type":"object",
    "properties":{
        "scopeItemAssignmentActivityId":{
            "type":"integer",
            "description":"The system-generated identifier of a scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignmentCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskScoreTypeIdentifier

Type: object

Title: RiskScoreTypeIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• riskScoreTypeId: integer (int64)
  The unique identifier of a score type.
• riskScoreTypeName: string
  Maximum Length: 255

  The name of the risk score type.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RiskScoreTypeIdentifier",
    "type":"object",
    "properties":{
        "riskScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier of a score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the risk score type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskMatrixIdentifier

Type: object

Title: RiskMatrixIdentifier

Show Source

• matrixName: string
  Maximum Length: 60

  The name of the risk scoring matrix.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• riskMatrixId: integer (int64)
  The system-generated identifier of the risk matrix.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RiskMatrixIdentifier",
    "type":"object",
    "properties":{
        "riskMatrixId":{
            "type":"integer",
            "description":"The system-generated identifier of the risk matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "matrixName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectRiskIdentifier

Type: object

Title: ProjectRiskIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectRiskIdentifier",
    "type":"object",
    "properties":{
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramRiskIdentifier

Type: object

Title: ProgramRiskIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• programRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramRiskIdentifier",
    "type":"object",
    "properties":{
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ActivityRiskIdentifier

Type: object

Title: ActivityRiskIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier of an activity assigned to a risk.
• activityRiskId: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ActivityRiskIdentifier",
    "type":"object",
    "properties":{
        "activityId":{
            "type":"integer",
            "description":"The unique identifier of an activity assigned to a risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityRiskId":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskMitigationIdentifier

Type: object

Title: RiskMitigationIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• riskMitigationCode: string
  Maximum Length: 60

  The unique identifier for the risk response action item.
• riskMitigationId: integer (int64)
  The system-generated identifier of a risk mitigation.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"RiskMitigationIdentifier",
    "type":"object",
    "properties":{
        "riskMitigationId":{
            "type":"integer",
            "description":"The system-generated identifier of a risk mitigation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskMitigationCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk response action item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramRiskMitigationIdentifier

Type: object

Title: ProgramRiskMitigationIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• programRiskId: integer (int64)
  The system-generated identifier of the project risk.
• programRiskMitigationCode: string
  Maximum Length: 60

  The unique identifier for the risk response action item.
• programRiskMitigationId: integer (int64)
  The system-generated identifier of a risk mitigation.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProgramRiskMitigationIdentifier",
    "type":"object",
    "properties":{
        "programRiskMitigationId":{
            "type":"integer",
            "description":"The system-generated identifier of a risk mitigation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programRiskMitigationCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk response action item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramRiskWeatherPeriodIdentifier

Type: object

Title: ProgramRiskWeatherPeriodIdentifier

Show Source

• periodName: string
  Maximum Length: 255

  The name of the period.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• programRiskId: integer (int64)
  The system-generated identifier of the project risk.
• programRiskWeatherPeriodId: integer (int64)
  The system-generated identifier for the period.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProgramRiskWeatherPeriodIdentifier",
    "type":"object",
    "properties":{
        "programRiskWeatherPeriodId":{
            "type":"integer",
            "description":"The system-generated identifier for the period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "periodName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the period.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : HolidayGroupIdentifier

Type: object

Title: HolidayGroupIdentifier

Show Source

• holidayGroupName: string
  Maximum Length: 60

  The name of the holiday list.
• holidayListId: integer (int64)
  The unique identifier for the holiday list.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"HolidayGroupIdentifier",
    "type":"object",
    "properties":{
        "holidayListId":{
            "type":"integer",
            "description":"The unique identifier for the holiday list.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "holidayGroupName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the holiday list.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RiskWeatherPeriodIdentifier

Type: object

Title: RiskWeatherPeriodIdentifier

Show Source

• periodName: string
  Maximum Length: 255

  The name of the period.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Maximum Length: 60

  The unique identifier for the risk.
• riskWeatherPeriodId: integer (int64)
  The system-generated identifier for the period.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"RiskWeatherPeriodIdentifier",
    "type":"object",
    "properties":{
        "periodName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the period.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskWeatherPeriodId":{
            "type":"integer",
            "description":"The system-generated identifier for the period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : PortfolioIdentifier

Type: object

Title: PortfolioIdentifier

Show Source

• name: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• portfolioId: integer (int64)
  The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"PortfolioIdentifier",
    "type":"object",
    "properties":{
        "name":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : PortfolioMeasureIdentifier

Type: object

Title: PortfolioMeasureIdentifier

Show Source

• measureId: integer (int64)
  The unique identifier of a portfolio measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioId: integer (int64)
  The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• portfolioMeasureId: integer (int64)
  The unique identifier of a portfolio measure.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"PortfolioMeasureIdentifier",
    "type":"object",
    "properties":{
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : EntityReferenceIdentifier

Type: object

Title: EntityReferenceIdentifier

Show Source

• entityReferenceId: integer (int64)
  The system-generated identifier of a reference.

{
    "title":"EntityReferenceIdentifier",
    "type":"object",
    "properties":{
        "entityReferenceId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : PortfolioMeasureManualValueIdentifier

Type: object

Title: PortfolioMeasureManualValueIdentifier

Show Source

• beginDate: string (date-time)
  The start date of a portfolio.
• capitalPortfolioId: integer (int64)
  The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.
• endDate: string (date-time)
  The end date of the portfolio.
• measureId: integer (int64)
  The unique identifier of a portfolio measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• portfolioMeasureManualValueId: integer (int64)
  The unique identifier of a portfolio measure.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"PortfolioMeasureManualValueIdentifier",
    "type":"object",
    "properties":{
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The unique identifier for the portfolio.The portfolio object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioMeasureManualValueId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "beginDate":{
            "type":"string",
            "description":"The start date of a portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The end date of the portfolio.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CustomLogTypeObjectIdentifier

Type: object

Title: CustomLogTypeObjectIdentifier

Show Source

• customLogTypeObjectId: integer (int64)
  The system-generated identifier of custom log type object.
• customLogTypeObjectName: string
  The user-defined identifier of a custom log type object.
• scope: string
  Maximum Length: 40

  Allowed Values: [ "project", "program", "workspace" ]

  The scope of an object.
• scopeCode: string
  The user-defined identifier of a reference to another object.
• scopeId: integer (int64)
  The system-generated identifier of a reference to another object.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CustomLogTypeObjectIdentifier",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference to another object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "maxLength":"40",
            "type":"string",
            "description":"The scope of an object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "project",
                "program",
                "workspace"
            ]
        },
        "scopeCode":{
            "type":"string",
            "description":"The user-defined identifier of a reference to another object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "type":"string",
            "description":"The user-defined identifier of a custom log type object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectId":{
            "type":"integer",
            "description":"The system-generated identifier of custom log type object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CustomLogItemIdentifier

Type: object

Title: CustomLogItemIdentifier

Show Source

• customLogItemCode: string
  Maximum Length: 60

  A unique identifier unique of the custom log item.
• customLogItemId: integer (int64)
  The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.
• customLogTypeObjectId: integer (int64)
  The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.
• customLogTypeObjectName: string
  The user-specified identifier of a custom log type.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CustomLogItemIdentifier",
    "type":"object",
    "properties":{
        "customLogItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"A unique identifier unique of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "type":"string",
            "description":"The user-specified identifier of a custom log type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectId":{
            "type":"integer",
            "description":"The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectRankIdentifier

Type: object

Title: ProjectRankIdentifier

Show Source

• evaluationCategoryId: integer (int64)
  Evaluation category ID.
• evaluationSubCategoryId: integer (int64)
  Evaluation subcategory ID.
• projectId: integer (int64)
  The system-generated identifier of the project.
• projectRankId: integer (int64)
  The system-generated identifier of the project rank.

{
    "title":"ProjectRankIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRankId":{
            "type":"integer",
            "description":"The system-generated identifier of the project rank.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "evaluationCategoryId":{
            "type":"integer",
            "description":"Evaluation category ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "evaluationSubCategoryId":{
            "type":"integer",
            "description":"Evaluation subcategory ID.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectDependencyIdentifier

Type: object

Title: ProjectDependencyIdentifier

Show Source

• dependentProjectCode: string
  The project code of a project that has other projects that it relies on for support.
• dependentProjectId: integer (int64)
  The unique identifier of a project that has other projects that it relies on for support.
• dependentProjectWorkspaceCode: string
  The workspace code of a project that has other projects that it relies on for support.#project invalid inputs
• projectCode: string
  The project code of a project that has other projects depending on it.
• projectDependencyId: integer (int64)
  The unique identifier of a project dependency.
• projectId: integer (int64)
  The unique identifier of a project that has other projects depending on it.
• projectWorkspaceCode: string
  The workspace code of a project that has other projects depending on it.

{
    "title":"ProjectDependencyIdentifier",
    "type":"object",
    "properties":{
        "projectDependencyId":{
            "type":"integer",
            "description":"The unique identifier of a project dependency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dependentProjectId":{
            "type":"integer",
            "description":"The unique identifier of a project that has other projects that it relies on for support.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dependentProjectCode":{
            "type":"string",
            "description":"The project code of a project that has other projects that it relies on for support.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectWorkspaceCode":{
            "type":"string",
            "description":"The workspace code of a project that has other projects depending on it.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dependentProjectWorkspaceCode":{
            "type":"string",
            "description":"The workspace code of a project that has other projects that it relies on for support.#project invalid inputs",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project that has other projects depending on it.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "type":"string",
            "description":"The project code of a project that has other projects depending on it.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : LocationIdentifier

Type: object

Title: LocationIdentifier

Show Source

• locationCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the location.
• locationId: integer (int64)
  The unique identifier for the location.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"LocationIdentifier",
    "type":"object",
    "properties":{
        "locationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "locationCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : MeasureIdentifier

Type: object

Title: MeasureIdentifier

Show Source

• measureId: integer (int64)
  The unique identifier of a measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"MeasureIdentifier",
    "type":"object",
    "properties":{
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : MeasureThresholdIdentifier

Type: object

Title: MeasureThresholdIdentifier

Show Source

• computeAgainstType: string
  Allowed Values: [ "ACTUAL_VALUE", "PERCENT_OF_TARGET" ]

  The against type of a threshold.
• desirableState: string
  Allowed Values: [ "HIGH_VALUES", "LOW_VALUES" ]

  The type of direction of a threshold.
• measureId: integer (int64)
  The unique identifier of a measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• measureThresholdId: integer (int64)
  The unique identifier of a threshold.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"MeasureThresholdIdentifier",
    "type":"object",
    "properties":{
        "measureThresholdId":{
            "type":"integer",
            "description":"The unique identifier of a threshold.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "computeAgainstType":{
            "type":"string",
            "description":"The against type of a threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTUAL_VALUE",
                "PERCENT_OF_TARGET"
            ]
        },
        "desirableState":{
            "type":"string",
            "description":"The type of direction of a threshold.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "HIGH_VALUES",
                "LOW_VALUES"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ReportCycleIdentifier

Type: object

Title: ReportCycleIdentifier

Show Source

• cycleName: string
  Maximum Length: 255

  The name of the reporting cycle.
• reportCycleId: integer (int64)
  The unique identifier of a report cycle.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ReportCycleIdentifier",
    "type":"object",
    "properties":{
        "cycleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the reporting cycle.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reportCycleId":{
            "type":"integer",
            "description":"The unique identifier of a report cycle.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : UnitsOfMeasureIdentifier

Type: object

Title: UnitsOfMeasureIdentifier

Show Source

• key: string
  Maximum Length: 60

  The abbreviation for the unit of measure name.
• unitOfMeasureId: integer (int64)
  The unique identifier for the unit of measure.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"UnitsOfMeasureIdentifier",
    "type":"object",
    "properties":{
        "key":{
            "maxLength":"60",
            "type":"string",
            "description":"The abbreviation for the unit of measure name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the unit of measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : WorkspaceIdentifier

Type: object

Title: WorkspaceIdentifier

Show Source

• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"WorkspaceIdentifier",
    "type":"object",
    "properties":{
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApplicationUserGroupIdentifier

Type: object

Title: ApplicationUserGroupIdentifier

Show Source

• applicationUserGroupId: integer (int64)
  The unique identifier of a user group.
• groupName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of a user group.
• scope: string
  Allowed Values: [ "PROJECT", "WORKSPACE" ]

  Type of a user group.
• scopeCode: string
  The unique identifier for a project/workspace set by the user who created the project/workspace.
• scopeId: integer (int64)
  The unique identifier of a project/workspace.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApplicationUserGroupIdentifier",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The unique identifier of a project/workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "type":"string",
            "description":"Type of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "WORKSPACE"
            ]
        },
        "applicationUserGroupId":{
            "type":"integer",
            "description":"The unique identifier of a user group.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "groupName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"Name of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeCode":{
            "type":"string",
            "description":"The unique identifier for a project/workspace set by the user who created the project/workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CalendarIdentifier

Type: object

Title: CalendarIdentifier

Show Source

• calendarCode: string
  Maximum Length: 255

  The unique code for the calendar.
• calendarId: integer (int64)
  The unique identifier for the calendar.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CalendarIdentifier",
    "type":"object",
    "properties":{
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique code for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CodeTypeIdentifier

Type: object

Title: CodeTypeIdentifier

Show Source

• codeTypeCode: string
  Displays the code or ID of the Code Type.
• codeTypeId: integer (int64)
  The system-generated identifier of a code type.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CodeTypeIdentifier",
    "type":"object",
    "properties":{
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CodeValueIdentifier

Type: object

Title: CodeValueIdentifier

Show Source

• codeTypeCode: string
  Displays the code or ID of the Code Type.
• codeTypeId: integer (int64)
  The system-generated identifier of a code type.
• codeValueCode: string
  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• parentCVCodes: array parentCVCodes
  List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"CodeValueIdentifier",
    "type":"object",
    "properties":{
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentCVCodes":{
            "type":"array",
            "description":"List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CostCategoryIdentifier

Type: object

Title: CostCategoryIdentifier

Show Source

• abbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviation for the cost category name.
• costCategoryId: integer (int64)
  The system-generated identifier of a cost category.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the cost category.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CostCategoryIdentifier",
    "type":"object",
    "properties":{
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviation for the cost category name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CurveIdentifier

Type: object

Title: CurveIdentifier

Show Source

• curveId: integer (int64)
  The unique identifier of a curve.
• curveName: string
  Maximum Length: 255

  The name of the curve profile.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CurveIdentifier",
    "type":"object",
    "properties":{
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : DocumentFolderStructureTemplateIdentifier

Type: object

Title: DocumentFolderStructureTemplateIdentifier

Show Source

• documentFolderStructureTemplateId: integer (int64)
  The system-generated identifier of a document folder structure template.
• templateName: string
  Maximum Length: 255

  The name of the document template.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"DocumentFolderStructureTemplateIdentifier",
    "type":"object",
    "properties":{
        "documentFolderStructureTemplateId":{
            "type":"integer",
            "description":"The system-generated identifier of a document folder structure template.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "templateName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the document template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : IdeaIdentifier

Type: object

Title: IdeaIdentifier

Show Source

• ideaId: integer (int64)
  The system-generated identifier of an idea.
• ideaName: string
  The name of the Idea.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"IdeaIdentifier",
    "type":"object",
    "properties":{
        "ideaName":{
            "type":"string",
            "description":"The name of the Idea.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ideaId":{
            "type":"integer",
            "description":"The system-generated identifier of an idea.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : OfficeIdentifier

Type: object

Title: OfficeIdentifier

Show Source

• companyId: integer (int64)
  The system-generated identifier of a company.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the company.
• countryCode: string
  Maximum Length: 3

  The country for a location.
• officeId: integer (int64)
  The unique identifier of an office.
• officeName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the office.
• postalCode: string
  Maximum Length: 20

  The postal code, post code, or zip code of a location.

{
    "title":"OfficeIdentifier",
    "type":"object",
    "properties":{
        "officeId":{
            "type":"integer",
            "description":"The unique identifier of an office.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "officeName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the office.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectCompanyIdentifier

Type: object

Title: ProjectCompanyIdentifier

Show Source

• companyId: integer (int64)
  The system-generated identifier of a company.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the company.
• postalCode: string
  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectCompanyId: integer (int64)
  The system-generated unique identifier of the project company.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectCompanyIdentifier",
    "type":"object",
    "properties":{
        "projectCompanyId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the project company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The system-generated identifier of a company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceDemandIdentifier

Type: object

Title: ResourceDemandIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceDemandId: integer (int64)
  The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ResourceDemandIdentifier",
    "type":"object",
    "properties":{
        "resourceDemandId":{
            "type":"integer",
            "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectBudgetChangeIdentifier

Type: object

Title: ProjectBudgetChangeIdentifier

Show Source

• budgetChangeCode: string
  Maximum Length: 60

  The unique identifier of the project budget change request.
• budgetChangeId: integer (int64)
  The system-generated identifier of a budget change.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectBudgetChangeIdentifier",
    "type":"object",
    "properties":{
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetChangeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the project budget change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectBudgetTransferIdentifier

Type: object

Title: ProjectBudgetTransferIdentifier

Show Source

• budgetTransferCode: string
  Maximum Length: 60

  The unique identifier of the project budget transfer request.
• budgetTransferId: integer (int64)
  The system-generated identifier of a budget transfer.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectBudgetTransferIdentifier",
    "type":"object",
    "properties":{
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget transfer.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetTransferCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the project budget transfer request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectResourceWorkRateIdentifier

Type: object

Title: ProjectResourceWorkRateIdentifier

Show Source

• effectiveStartDate: string (date-time)
  Date that the corresponding units/time period and rates go into effect for the resource or role.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• projectResourceId: integer (int64)
  The unique identifier of a project resource.
• projectResourceWorkRateId: integer (int64)
  The unique identifier of a project work rate.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  The code of a resource of a project resource.
• resourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectResourceWorkRateIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "type":"string",
            "description":"The code of a resource of a project resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "effectiveStartDate":{
            "type":"string",
            "description":"Date that the corresponding units/time period and rates go into effect for the resource or role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectResourceWorkRateId":{
            "type":"integer",
            "description":"The unique identifier of a project work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectResourceId":{
            "type":"integer",
            "description":"The unique identifier of a project resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectActualsLineItemIdentifier

Type: object

Title: ProjectActualsLineItemIdentifier

Show Source

• projectActualsCode: string
  The user-specified identifier of a project actual.
• projectActualsId: integer (int64)
  The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
• projectActualsLineItemCode: string
  Maximum Length: 60

  The user-specified unique identifier for an actual line item.
• projectActualsLineItemId: integer (int64)
  The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectActualsLineItemIdentifier",
    "type":"object",
    "properties":{
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsLineItemId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsLineItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for an actual line item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "type":"string",
            "description":"The user-specified identifier of a project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectActualsIdentifier

Type: object

Title: ProjectActualsIdentifier

Show Source

• projectActualsCode: string
  The user-specified identifier of a project actual.
• projectActualsId: integer (int64)
  The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectActualsIdentifier",
    "type":"object",
    "properties":{
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsCode":{
            "type":"string",
            "description":"The user-specified identifier of a project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectBudgetItemIdentifier

Type: object

Title: ProjectBudgetItemIdentifier

Show Source

• budgetItemCode: string
  Maximum Length: 60

  The unique identifier of the project budget item.
• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ProjectBudgetItemIdentifier",
    "type":"object",
    "properties":{
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the project budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramIdentifier

Type: object

Title: ProgramIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramIdentifier",
    "type":"object",
    "properties":{
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : StrategyIdentifier

Type: object

Title: StrategyIdentifier

Show Source

• strategyId: integer (int64)
  The system-generated identifier of the strategy.
• strategyName: string
  The name of a strategy.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"StrategyIdentifier",
    "type":"object",
    "properties":{
        "strategyId":{
            "type":"integer",
            "description":"The system-generated identifier of the strategy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "strategyName":{
            "type":"string",
            "description":"The name of a strategy.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : StrategyTypeIdentifier

Type: object

Title: StrategyTypeIdentifier

Show Source

• levelName: string
  The name of a strategy.
• strategyTypeId: integer (int64)
  The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"StrategyTypeIdentifier",
    "type":"object",
    "properties":{
        "levelName":{
            "type":"string",
            "description":"The name of a strategy.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategyTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RuleOfCreditIdentifier

Type: object

Title: RuleOfCreditIdentifier

Show Source

• rocId: integer (int64)
  Unique identifier of the rule of credit.
• rocName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the rule of credit.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RuleOfCreditIdentifier",
    "type":"object",
    "properties":{
        "rocId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rocName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceRoleAssignmentIdentifier

Type: object

Title: ResourceRoleAssignmentIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• resourceRoleAssignmentId: integer (int64)
  The system-generated identifier of the resource role assignment.
• roleCode: string
  The user-specified identifier of the role.
• roleId: integer (int64)
  The unique identifier for the role.The role object can also be identified by its unique criteria.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ResourceRoleAssignmentIdentifier",
    "type":"object",
    "properties":{
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "roleId":{
            "type":"integer",
            "description":"The unique identifier for the role.The role object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "roleCode":{
            "type":"string",
            "description":"The user-specified identifier of the role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceRoleAssignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of the resource role assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : BudgetPlanningScenarioIdentifier

Type: object

Title: BudgetPlanningScenarioIdentifier

Show Source

• planPeriod: integer (int32)
  The period during which budget is allocated to projects within the plan.
  This value determines the year in which budget planning timescales start.
  You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021.
  After the planning period for a budget plan has been set it cannot be changed.
• portfolioId: integer (int64)
  The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• portfolioName: string
  Maximum Length: 255

  The name of the portfolio.
• scenarioId: integer (int64)
  The system-generated identifier of the Budget Plan Scenario.
• scenarioName: string
  Maximum Length: 255

  The name of Budget Plan Scenario.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"BudgetPlanningScenarioIdentifier",
    "type":"object",
    "properties":{
        "scenarioId":{
            "type":"integer",
            "description":"The system-generated identifier of the Budget Plan Scenario.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scenarioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of Budget Plan Scenario.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "planPeriod":{
            "type":"integer",
            "description":"The period during which budget is allocated to projects within the plan. <br />This value determines the year in which budget planning timescales start. <br />You can set the planning period to either the current or following year. For example, if the year is 2020 the latest planning period you can set is 2021. <br />After the planning period for a budget plan has been set it cannot be changed.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "portfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ScopeAssignmentPlannedTimePhasedDataIdentifier

Type: object

Title: ScopeAssignmentPlannedTimePhasedDataIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• scopeAssignmentPlannedTimePhasedDataId: integer (int64)
  The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.
• scopeItemAssignCode: string
  Maximum Length: 60

  The user-specified unique identifier for the scope assignment.
• scopeItemAssignmentId: integer (int64)
  The unique identifier for the scope item assigned to the work package.
• workPackageCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the work package.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"ScopeAssignmentPlannedTimePhasedDataIdentifier",
    "type":"object",
    "properties":{
        "scopeAssignmentPlannedTimePhasedDataId":{
            "type":"integer",
            "description":"The unique identifier of scope assignment plan data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemAssignCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier for the scope assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeItemAssignmentId":{
            "type":"integer",
            "description":"The unique identifier for the scope item assigned to the work package.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workPackageCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the work package.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramBudgetTransferIdentifier

Type: object

Title: ProgramBudgetTransferIdentifier

Show Source

• programBudgetId: integer (int64)
  The system-generated identifier of a program budget.
• programBudgetTransferCode: string
  Maximum Length: 60

  The unique identifier of the program budget transfer request.
• programBudgetTransferId: integer (int64)
  The system-generated identifier of a program budget transfer.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramBudgetTransferIdentifier",
    "type":"object",
    "properties":{
        "programBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransferId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget transfer. ",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetTransferCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget transfer request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramBudgetChangeIdentifier

Type: object

Title: ProgramBudgetChangeIdentifier

Show Source

• programBudgetChangeCode: string
  Maximum Length: 60

  The unique identifier of the program budget change request.
• programBudgetChangeId: integer (int64)
  The system-generated identifier of a program budget change.
• programBudgetId: integer (int64)
  The system-generated identifier of a program budget.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramBudgetChangeIdentifier",
    "type":"object",
    "properties":{
        "programBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetChangeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programBudgetChangeId":{
            "type":"integer",
            "description":"The system-generated identifier of a program budget change.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ActivityIdentifier

Type: object

Title: ActivityIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ActivityIdentifier",
    "type":"object",
    "properties":{
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : AssignmentIdentifier

Type: object

Title: AssignmentIdentifier

Show Source

• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• assignmentCode: string
  Maximum Length: 60

  A unique identifier for the assignment.
• assignmentId: integer (int64)
  The system-generated identifier of an assignment.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class of the resource of an assignment.
• resourceCode: string
  The user-specified identifier of a resource.
• resourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"AssignmentIdentifier",
    "type":"object",
    "properties":{
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of an assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentCode":{
            "maxLength":"60",
            "type":"string",
            "description":"A unique identifier for the assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "type":"string",
            "description":"The user-specified identifier of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class of the resource of an assignment. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : RelationshipIdentifier

Type: object

Title: RelationshipIdentifier

Show Source

• predActivityCode: string
  The code of the predecessor activity.
• predActivityId: integer (int64)
  The unique identifier of the predecessor of an activity.
• predProjectCode: string
  The code of the project of the predecessor of an activity.
• predWorkspaceCode: string
  The code of the workspace of the predecessor of an activity.
• relationshipId: integer (int64)
  The system-generated identifier of an activity relationship.
• succActivityCode: string
  The code of the successor activity.
• succActivityId: integer (int64)
  The unique identifier of the successor of an activity.
• succProjectCode: string
  The code of the project of the successor of an activity.
• succWorkspaceCode: string
  The code of the workspace of the successor of an activity.

{
    "title":"RelationshipIdentifier",
    "type":"object",
    "properties":{
        "relationshipId":{
            "type":"integer",
            "description":"The system-generated identifier of an activity relationship.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "predActivityId":{
            "type":"integer",
            "description":"The unique identifier of the predecessor of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "succActivityId":{
            "type":"integer",
            "description":"The unique identifier of the successor of an activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "predActivityCode":{
            "type":"string",
            "description":"The code of the predecessor activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "succActivityCode":{
            "type":"string",
            "description":"The code of the successor activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "predProjectCode":{
            "type":"string",
            "description":"The code of the project of the predecessor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "succProjectCode":{
            "type":"string",
            "description":"The code of the project of the successor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "succWorkspaceCode":{
            "type":"string",
            "description":"The code of the workspace of the successor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "predWorkspaceCode":{
            "type":"string",
            "description":"The code of the workspace of the predecessor of an activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : FundActualIdentifier

Type: object

Title: FundActualIdentifier

Show Source

• fundActualId: integer (int64)
  The system-generated identifier of a fund actual.
• fundCode: string
  The user-specified unique identifier of a fund.
• fundId: integer (int64)
  The system-generated identifier of a fund.
• projectActualsCode: string
  Maximum Length: 60

  The unique identifier for an actual.
• projectActualsId: integer (int64)
  The system-generated identifier of a project actual.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• workspaceCode: string
  The user-specified identifier of a workspace.

{
    "title":"FundActualIdentifier",
    "type":"object",
    "properties":{
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fundCode":{
            "type":"string",
            "description":"The user-specified unique identifier of a fund.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The system-generated identifier of a project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualsCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for an actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fundActualId":{
            "type":"integer",
            "description":"The system-generated identifier of a fund actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramBudgetItemIdentifier

Type: object

Title: ProgramBudgetItemIdentifier

Show Source

• programBudgetId: integer (int64)
  The ID of the program budget.
• programBudgetItemCode: string
  Maximum Length: 60

  The unique identifier of the program budget item.
• programBudgetItemId: integer (int64)
  The system-generated identifier for a budget.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramBudgetItemIdentifier",
    "type":"object",
    "properties":{
        "programBudgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for a budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetId":{
            "type":"integer",
            "description":"The ID of the program budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programBudgetItemCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the program budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : parentCVCodes

Type: array

List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

400 Response

Invalid input for the calendar service. Verify the request contains valid data, then resubmit the request.

Back to Top