Jump to

• Request
• Response

Update a Scope Item

put

/api/restapi/scopeItem

Send a request to this endpoint to update a scope item.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityScopeItemInput

Type: object

Title: ApiEntityScopeItemInput

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

• scopeItemId
• scopeItemCode,pbsId,projectId
• scopeItemCode,pbsCodeHierarchy,projectId
• scopeItemCode,pbsId,projectCode,workspaceCode
• scopeItemCode,pbsCodeHierarchy,projectCode,workspaceCode

Show Source

• actualUnitsToDate: number (double)
  The total amount of the scope item installed.
  Calculated as the sum of Installed Quantity for all scope assignments.
• approvedChangedHours: number (double)
  The total number of hours approved for scope item changes.
• approvedChangedUnits: number (double)
  The total quantity approved for scope item changes.
• assignedHours: number (double)
  Minimum Value: 0

  The total number of hours that have been distributed to work packages by way of scope assignments. After the original baseline is set, this number includes all approved hour changes.
• assignedUnits: number (double)
  Minimum Value: 0

  The total quantity distributed to work packages by way of scope assignments. After the original baseline is set, this number is updated to also reflect scope assignments that are created from approved quantity changes of the scope item.
• atCompletionUnits: number (double)
  The total amount of the scope item to be installed for the project.
  Calculated as Revised Quantity plus Adjusted Quantity.
• baselineHours: number (double)
  Minimum Value: 0

  The Revised Hours at the time the baseline was set.
• baselineUnits: number (double)
  Minimum Value: 0

  The total quantity that has not been distributed to work packages. This is the amount that is available for distribution to scope assignments. After the original baseline is set, this includes all approved quantity changes for scope items.
• cbsCodes: array cbsCodes
  List of cbs codes in hierarchy for the CBS which needs to be associated with the item. 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.
• cbsSheetCodeId: integer (int64)
  The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
• configuredFields: array configuredFields
  The list of configured fields for a scope item.
• costCategoryAbbr: 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.
• currentHoursPerUnit: number (double)
  The number of hours required to install a single quantity of the scope item material or product based on current values.
  For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
  This field is recalculated if Current Hours are changed.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Details describing the scope item.
• effectiveFinish: string (date-time)
  The latest Effective Finish date for Actual to Date values of all scope item's scope assignments.
• effectiveStart: string (date-time)
  The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments.
• etcAdjustedUnits: number (double)
  The scope item quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved.
  This is a manual entry field.
• installedUnits: number (double)
  The amount of material or product that has been installed to date.
  This is the cumulative value for all scope assignments created for the scope item.
• itemCodeUpper: string
  Minimum Length: 1

  Maximum Length: 60

  The code of an upper scope item.
• itemName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the scope item.
• itemNameUpper: string
  Minimum Length: 1

  Maximum Length: 255

  The name of an upper scope item.
• pbsCodeHierarchy: array pbsCodeHierarchy
  The list of PBS codes in hierarchical way.
• pbsId(required): integer (int64)
  The system-generated identifier of the parent PBS associated with the scope item.
• pendingChangedHours: number (double)
  The total number of hours waiting for approval on a scope item.
• pendingChangedUnits: number (double)
  The total quantity waiting for approval on a scope item.
• percentComplete: number (double)
  Sum of Quantity Completed Weight for the scope items assigned to work packages divided by Revised Quantity for the scope item.
• plannedHours: number (double)
  Minimum Value: 0

  The original expected hours needed to complete all the work on a scope item.
  Calculated as Original Quantity multiplied by Original Productivity Rate.
• plannedHoursPerUnit: number (double)
  Minimum Value: 0

  The number of hours required to install or assemble a single quantity of the scope item material or product.
  For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable.
  Calculated as Original Hours divided by Original Quantity.
• plannedUnits: number (double)
  Minimum Value: 0

  The original expected amount of material or product required for a scope item.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• remainingUnits: number (double)
  The quantity remaining for the scope item.
  Calculated as Revised Quantity for the scope item minus the sum of Installed Quantity for the scope item's assignments.
• revisedHours: number (double)
  Minimum Value: 0

  The total number of hours needed to complete all the work on a scope item, including any approved changes. This value equals the Original Hours before the original baseline is set.
  Calculated as the sum of Original Hours plus Approved Changed Hours, if any.
• revisedUnits: number (double)
  Minimum Value: 0

  The total quantity that has been revised to account for approved changes for a scope item.
  Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.
• scopeItemCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier for the scope item.
• scopeItemCodeValue: array scopeItemCodeValue
  The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.
• scopeItemId: integer (int64)
  The system-generated identifier of a scope item.
• status: string
  Allowed Values: [ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]

  The state of the scope item in the change request.
• unAssignedHours: number (double)
  The total number of hours that have not been distributed to work packages for a scope item. This is the amount that is available for distribution to scope assignments. After the original baselines is set, this includes all Approved Change Hours.
• unAssignedUnits: number (double)
  Minimum Value: 0

  The total number of hours waiting for approval on a scope item.
• unitOfMeasureId: integer (int64)
  The name of the measurement type used to describe the quantity of a scope item.
• weightedUnits: number (double)
  The amount of material or product that has been weighted to date.
  This is the cumulative value for all scope assignments created for the scope item.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityScopeItemInput",
    "required":[
        "itemName",
        "pbsId",
        "projectId",
        "scopeItemCode"
    ],
    "type":"object",
    "properties":{
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The name of the measurement type used to describe the quantity of a scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "status":{
            "type":"string",
            "description":"The state of the scope item in the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "APPROVED",
                "REJECTED",
                "WITHDRAW_APPROVAL",
                "REOPEN"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCodes":{
            "type":"array",
            "description":"List of cbs codes in hierarchy for the CBS which needs to be associated with the item. 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"
            ]
        },
        "approvedChangedHours":{
            "type":"number",
            "description":"The total number of hours approved for scope item changes.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pendingChangedHours":{
            "type":"number",
            "description":"The total number of hours waiting for approval on a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionUnits":{
            "type":"number",
            "description":"The total amount of the scope item to be installed for the project. <br />Calculated as Revised Quantity plus Adjusted Quantity.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pbsId":{
            "type":"integer",
            "description":"The system-generated identifier of the parent PBS associated with the scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemCodeValue":{
            "type":"array",
            "description":"The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueScopeItemInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "pbsCodeHierarchy":{
            "type":"array",
            "description":"The list of PBS codes in hierarchical way.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Details describing the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "approvedChangedUnits":{
            "type":"number",
            "description":"The total quantity approved for scope item changes.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pendingChangedUnits":{
            "type":"number",
            "description":"The total quantity waiting for approval on a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "etcAdjustedUnits":{
            "type":"number",
            "description":"The scope item quantity that is not yet accounted for. For example, you might enter a value to represent pending change requests that are likely to be approved. <br />This is a manual entry field.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualUnitsToDate":{
            "type":"number",
            "description":"The total amount of the scope item installed. <br />Calculated as the sum of Installed Quantity for all scope assignments.",
            "format":"double",
            "exampleSetFlag":false
        },
        "currentHoursPerUnit":{
            "type":"number",
            "description":"The number of hours required to install a single quantity of the scope item material or product based on current values. <br />For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable. <br />This field is recalculated if Current Hours are changed.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "costCategoryAbbr":{
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"The abbreviation for the cost category name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedHoursPerUnit":{
            "minimum":0,
            "type":"number",
            "description":"The number of hours required to install or assemble a single quantity of the scope item material or product. <br />For example, if the product is 1,000 feet of cable it may be estimated to take 2 hours install one foot of cable. <br />Calculated as Original Hours divided by Original Quantity.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "weightedUnits":{
            "type":"number",
            "description":"The amount of material or product that has been weighted to date. <br />This is the cumulative value for all scope assignments created for the scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeItemCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified unique identifier for the scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "installedUnits":{
            "type":"number",
            "description":"The amount of material or product that has been installed to date. <br />This is the cumulative value for all scope assignments created for the scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "scopeItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignedUnits":{
            "minimum":0,
            "type":"number",
            "description":"The total quantity distributed to work packages by way of scope assignments. After the original baseline is set, this number is updated to also reflect scope assignments that are created from approved quantity changes of the scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "revisedUnits":{
            "minimum":0,
            "type":"number",
            "description":"The total quantity that has been revised to account for approved changes for a scope item. <br />Calculated as Original Quantity plus Approved Change Quantity. Revised Quantity equals the Original Quantity before the original is baseline set.",
            "format":"double",
            "exampleSetFlag":false
        },
        "assignedHours":{
            "minimum":0,
            "type":"number",
            "description":"The total number of hours that have been distributed to work packages by way of scope assignments. After the original baseline is set, this number includes all approved hour changes.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unAssignedHours":{
            "type":"number",
            "description":"The total number of hours that have not been distributed to work packages for a scope item. This is the amount that is available for distribution to scope assignments. After the original baselines is set, this includes all Approved Change Hours.",
            "format":"double",
            "exampleSetFlag":false
        },
        "unAssignedUnits":{
            "minimum":0,
            "type":"number",
            "description":"The total number of hours waiting for approval on a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "effectiveStart":{
            "type":"string",
            "description":"The earliest Effective Start date for Actual to Date values of all the scope item's scope assignments.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveFinish":{
            "type":"string",
            "description":"The latest Effective Finish date for Actual to Date values of all scope item's scope assignments.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemCodeUpper":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of an upper scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "itemNameUpper":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of an upper scope item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a scope item.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityScopeItemConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "baselineUnits":{
            "minimum":0,
            "type":"number",
            "description":"The total quantity that has not been distributed to work packages. This is the amount that is available for distribution to scope assignments. After the original baseline is set, this includes all approved quantity changes for scope items.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedUnits":{
            "minimum":0,
            "type":"number",
            "description":"The original expected amount of material or product required for a scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "remainingUnits":{
            "type":"number",
            "description":"The quantity remaining for the scope item. <br />Calculated as Revised Quantity for the scope item minus the sum of Installed Quantity for the scope item's assignments.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costCategoryName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineHours":{
            "minimum":0,
            "type":"number",
            "description":"The Revised Hours at the time the baseline was set.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedHours":{
            "minimum":0,
            "type":"number",
            "description":"The original expected hours needed to complete all the work on a scope item. <br />Calculated as Original Quantity multiplied by Original Productivity Rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "revisedHours":{
            "minimum":0,
            "type":"number",
            "description":"The total number of hours needed to complete all the work on a scope item, including any approved changes. This value equals the Original Hours before the original baseline is set. <br />Calculated as the sum of Original Hours plus Approved Changed Hours, if any.",
            "format":"double",
            "exampleSetFlag":false
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "percentComplete":{
            "type":"number",
            "description":"Sum of Quantity Completed Weight for the scope items assigned to work packages divided by Revised Quantity for the scope item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ScopeItem object, a unique ScopeItem object can be identified by the following combinations of the fields.<ul><li>scopeItemId</li><li>scopeItemCode,pbsId,projectId</li><li>scopeItemCode,pbsCodeHierarchy,projectId</li><li>scopeItemCode,pbsId,projectCode,workspaceCode</li><li>scopeItemCode,pbsCodeHierarchy,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : cbsCodes

Type: array

List of cbs codes in hierarchy for the CBS which needs to be associated with the item. 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 cbs codes in hierarchy for the CBS which needs to be associated with the item. 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"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a scope item.

Show Source

• Array of: object ApiEntityScopeItemConfiguredFieldValueInput
  Title: ApiEntityScopeItemConfiguredFieldValueInput

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

  • scopeItemConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"The list of configured fields for a scope item.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityScopeItemConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : pbsCodeHierarchy

Type: array

The list of PBS codes in hierarchical way.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of PBS codes in hierarchical way.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : scopeItemCodeValue

Type: array

The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueScopeItemInput
  Title: ApiEntityCodeValueScopeItemInput

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

  • codeValueScopeItemId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId

{
    "type":"array",
    "description":"The list of code values for a scope item. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueScopeItemInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityScopeItemConfiguredFieldValueInput

Type: object

Title: ApiEntityScopeItemConfiguredFieldValueInput

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

• scopeItemConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• scopeItemConfiguredFieldValueId: integer (int64)
  The unique identifier for the Scope Item Configured Field.
• scopeItemId: integer (int64)
  The system-generated identifier of a Scope Item.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.

{
    "title":"ApiEntityScopeItemConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "scopeItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a Scope Item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Scope Item Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a ScopeItemConfiguredFieldValue object, a unique ScopeItemConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>scopeItemConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCodeValueScopeItemInput

Type: object

Title: ApiEntityCodeValueScopeItemInput

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

• codeValueScopeItemId
• codeValueId
• codeTypeId,codeValueCode
• codeTypeCode,codeValueCode
• codeTypeCode,parentId,codeValueCode
• codeValueCode,codeTypeId,parentId
• codeTypeCode,codeValueCode,projectCode
• codeTypeCode,codeValueCode,projectId
• codeTypeCode,codeValueCode,parentId,projectCode
• codeTypeCode,codeValueCode,parentId,projectId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueScopeItemId: integer (int64)
  The unique identifier for the code value assigned to the scope item.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• scopeItemId: integer (int64)
  The unique identifier of a scope item.

{
    "title":"ApiEntityCodeValueScopeItemInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueScopeItemId":{
            "type":"integer",
            "description":"The unique identifier for the code value assigned to the scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scopeItemId":{
            "type":"integer",
            "description":"The unique identifier of a scope item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "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 code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueScopeItem object, a unique CodeValueScopeItem object can be identified by the following combinations of the fields.<ul><li>codeValueScopeItemId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Scope Item by Assigning Code Values Using Codes Update a Scope Item by Assigning Hierarchical Code Values Using Codes Update a Scope Item Update a Scope Item to Assign a Boolean Configured Field Update a Scope Item by Removing a Configured Field Update a Scope Item by Assigning Multiple Code Values Using IDs

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input.

Back to Top