Jump to

• Request
• Response

Batch Integrate Budget Items with an External Data Source

post

/api/restapi/budgetItem/syncBatch

Send a request to this endpoint to create or update one or more integrated budget items. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityExternallySourcedBudgetItemInput>

Type: array

Title: List<ApiEntityExternallySourcedBudgetItemInput>

Show Source

• Array of: object ApiEntityExternallySourcedBudgetItemInput
  Title: ApiEntityExternallySourcedBudgetItemInput

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

  • budgetItemId
  • budgetItemCode,projectId
  • budgetItemCode,projectCode,workspaceCode

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

Nested Schema : ApiEntityExternallySourcedBudgetItemInput

Type: object

Title: ApiEntityExternallySourcedBudgetItemInput

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

• budgetItemId
• budgetItemCode,projectId
• budgetItemCode,projectCode,workspaceCode

Show Source

• abbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviated name of a cost category.
• budgetItemCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier of the project budget item.
• budgetItemCost: budgetItemCost
  Contains Budget Item cost related fields.
• budgetItemId: integer (int64)
  The system-generated identifier of a budget item.
• 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(required): integer (int64)
  The unique identifier of the CBS Code.
• configuredFields: array configuredFields
  The list of configured fields for a budget item.
• costCategoryId: integer (int64)
  The type of cost associated with the budget item.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The cost category assigned to this budget item.
• itemName(required): string
  Minimum Length: 0

  Maximum Length: 255

  The name of the budget item.
• productionRate: number (double)
  Minimum Value: 0.000010

  The number of hours per unit of measure needed to complete the budget item.
• projectBudgetId: integer (int64)
  The system-generated identifier of a project budget.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The project associated with this budget item.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• quantity: number (double)
  The number of each budget item needed to complete the work.
• sourceId: string
  Maximum Length: 255

  The unique identifier of budget item data in an external source.
• unitsOfMeasureId: integer (int64)
  The Unit of Measure used for the budget item.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityExternallySourcedBudgetItemInput",
    "required":[
        "cbsSheetCodeId",
        "itemName",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "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 project associated with this budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"The abbreviated name of a cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costCategoryId":{
            "type":"integer",
            "description":"The type of cost associated with the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The unique identifier of the CBS Code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of budget item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "quantity":{
            "type":"number",
            "description":"The number of each budget item needed to complete the work.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "productionRate":{
            "minimum":"0.000010",
            "type":"number",
            "description":"The number of hours per unit of measure needed to complete the budget item.",
            "format":"double",
            "exampleSetFlag":false
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a budget item.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityBudgetItemConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "description":"The Unit of Measure used for the budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The cost category assigned to this budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectBudgetId":{
            "type":"integer",
            "description":"The system-generated identifier of a project budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "itemName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of the budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetItemCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The unique identifier of the project budget item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "budgetItemCost":{
            "description":"Contains Budget Item cost related fields.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBudgetItemCostInput"
                }
            ]
        },
        "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.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        }
    },
    "description":"This entity represents a ExternallySourcedBudgetItem object, a unique ExternallySourcedBudgetItem object can be identified by the following combinations of the fields.<ul><li>budgetItemId</li><li>budgetItemCode,projectId</li><li>budgetItemCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : budgetItemCost

Contains Budget Item cost related fields.

Match All

Contains Budget Item cost related fields.

Show Source

• object ApiEntityBudgetItemCostInput
  Title: ApiEntityBudgetItemCostInput

{
    "description":"Contains Budget Item cost related fields.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBudgetItemCostInput"
        }
    ]
}

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.",
    "writeOnly":true,
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "writeOnly":true,
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a budget item.

Show Source

• Array of: object ApiEntityBudgetItemConfiguredFieldValueInput
  Title: ApiEntityBudgetItemConfiguredFieldValueInput

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

  • budgetItemConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : ApiEntityBudgetItemCostInput

Type: object

Title: ApiEntityBudgetItemCostInput

Show Source

• budgetItemId(required): integer (int64)
  The system-generated identifier of a budget item.
• laborRateProject: number (double)
  The cost per labor hour of the budget line item. This value is based on the project currency.
• originalCostProject: number (double)
  The original cost of the budget line item. This value is based on the project currency.
• unitRateProject: number (double)
  The cost per Unit of Measure for the budget line item. This value is based on the project currency.

{
    "title":"ApiEntityBudgetItemCostInput",
    "required":[
        "budgetItemId"
    ],
    "type":"object",
    "properties":{
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a budget item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitRateProject":{
            "type":"number",
            "description":"The cost per Unit of Measure for the budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "laborRateProject":{
            "type":"number",
            "description":"The cost per labor hour of the budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "originalCostProject":{
            "type":"number",
            "description":"The original cost of the budget line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityBudgetItemConfiguredFieldValueInput

Type: object

Title: ApiEntityBudgetItemConfiguredFieldValueInput

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

• budgetItemConfiguredFieldValueId
• 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.
• budgetItemConfiguredFieldValueId: integer (int64)
  The unique identifier for the Budget Item Configured Field.
• budgetItemId: integer (int64)
  The system-generated identifier for an Budget.
• 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.
• textValue: string
  Maximum Length: 4000

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

{
    "title":"ApiEntityBudgetItemConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "budgetItemConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Budget Item Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "budgetItemId":{
            "type":"integer",
            "description":"The system-generated identifier for an Budget.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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 BudgetItemConfiguredFieldValue object, a unique BudgetItemConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>budgetItemConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create or Update Project Budget Items using budget item codes for Nonlabor Cost Category IDs Create or Update Project Budget Items using Codes Create or Update Project Budget Items to Assign a Configured Field

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : List<ApiEntityERPSyncApiResponse>

Type: array

Title: List<ApiEntityERPSyncApiResponse>

Show Source

• Array of: object ApiEntityERPSyncApiResponse
  Title: ApiEntityERPSyncApiResponse

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

Nested Schema : ApiEntityERPSyncApiResponse

Type: object

Title: ApiEntityERPSyncApiResponse

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 : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source 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
  Message is populated based on result of the operation.
  Success - Message will not be populated. Please refer the statusCode.
  Failure - Error message or reason for operation failure is populated.
  Warning - warning message is populated.
  The field is non-persistable and thus maximum length is not applicable.
• primaryKeyName: string
  The primary key field name associated with the integrated object.
  The field is non-persistable and thus maximum length is not applicable.
• primaryKeyValue: integer (int64)
  The unique identifier for the integrated object.
• sourceId: string
  Maximum Length: 255

  The unique identifier of the object in an external source.
• statusCode: integer (int32)
  The response code representing the state of the API operation.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityERPSyncApiResponse",
    "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"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "primaryKeyName":{
            "type":"string",
            "description":"The primary key field name associated with the integrated object.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "primaryKeyValue":{
            "type":"integer",
            "description":"The unique identifier for the integrated object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the object in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "message":{
            "type":"string",
            "description":"Message is populated based on result of the operation.<br>Success - Message will not be populated. Please refer the statusCode.<br>Failure - Error message or reason for operation failure is populated.<br>Warning - warning message is populated.<br />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> ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.",
            "exampleSetFlag":false,
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ProjectIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CBSSheetCodeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceIdentifier",
                    "exampleSetFlag":false
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "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 : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.

Match One Schema

Show Source

• object ProjectIdentifier
  Title: ProjectIdentifier
• object CBSSheetCodeIdentifier
  Title: CBSSheetCodeIdentifier
• object ResourceIdentifier
  Title: ResourceIdentifier

{
    "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> ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.",
    "exampleSetFlag":false,
    "oneOf":[
        {
            "$ref":"#/components/schemas/ProjectIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CBSSheetCodeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceIdentifier",
            "exampleSetFlag":false
        }
    ]
}

Nested Schema : ProjectIdentifier

Type: object

Title: ProjectIdentifier

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.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectIdentifier",
    "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CBSSheetCodeIdentifier

Type: object

Title: CBSSheetCodeIdentifier

Show Source

• cbsCode: string
  Maximum Length: 60

  The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.
• 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.
• costSheetId: integer (int64)
  The unique identifier of a cost sheet.
• parentId: integer (int64)
  The system-generated identifier of a parent cost item in a cost sheet.
• 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":"CBSSheetCodeIdentifier",
    "type":"object",
    "properties":{
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of a parent cost item in a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCode":{
            "maxLength":60,
            "type":"string",
            "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the 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 : ResourceIdentifier

Type: object

Title: ResourceIdentifier

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.
• resourceId: 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":"ResourceIdentifier",
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid Input.

Back to Top