Jump to

• Request
• Response

Integrate a CBS with an External Data Source

post

/api/restapi/cbs/project/sync

Send a request to this endpoint to create or update an integrated a CBS. 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 : ApiEntityExternallySourcedCBSSheetCodeInput

Type: object

Title: ApiEntityExternallySourcedCBSSheetCodeInput

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

• cbsSheetCodeId
• cbsCode,projectId
• cbsCode,projectCode,workspaceCode

Show Source

• cbsCode(required): string
  Minimum Length: 1

  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. This value should not be provided in create operation request data, however, it is required for update requests.
• costSheetId: integer (int64)
  The unique identifier of a cost sheet.
• costSheetRow: costSheetRow
  A CBS sheet row object.
• costType: string
  Allowed Values: [ "CAPITAL", "EXPENSE", "NONE" ]

  The category of the cost breakdown structure code.
  Expense: Represents an expense.
  Capital: Represents capital.
  None: Type is not divided into expense or capital. None is selected by default if no other choice is made.
• description: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the CBS code.
• isActive: boolean
  The active field indicates whether the CBS code is active for use.
• parentCBSCodes: array parentCBSCodes
  List of parent cbs codes 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 system-generated identifier of a parent cost item in a cost sheet.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• projectId(required): integer (int64)
  The unique identifier for the project.
• sourceId: string
  Maximum Length: 255

  The unique identifier of cost sheet item data in an external source.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The system-generated identifier of a workspace.

{
    "title":"ApiEntityExternallySourcedCBSSheetCodeInput",
    "required":[
        "cbsCode",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "workspaceId":{
            "type":"integer",
            "description":"The system-generated identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentCBSCodes":{
            "type":"array",
            "description":"List of parent cbs codes 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.",
            "writeOnly":true,
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "writeOnly":true,
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "description":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of the CBS code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costSheetRow":{
            "description":"A CBS sheet row object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityCBSSheetRowInput"
                }
            ]
        },
        "costType":{
            "type":"string",
            "description":"The category of the cost breakdown structure code. <br />Expense: Represents an expense. <br />Capital: Represents capital. <br />None: Type is not divided into expense or capital. None is selected by default if no other choice is made.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CAPITAL",
                "EXPENSE",
                "NONE"
            ]
        },
        "cbsCode":{
            "maxLength":60,
            "minLength":1,
            "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"
            ]
        },
        "isActive":{
            "type":"boolean",
            "description":"The active field indicates whether the CBS code is active for use.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of cost sheet item data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a 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 ExternallySourcedCBSSheetCode object, a unique ExternallySourcedCBSSheetCode object can be identified by the following combinations of the fields.<ul><li>cbsSheetCodeId</li><li>cbsCode,projectId</li><li>cbsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : costSheetRow

A CBS sheet row object.

Match All

A CBS sheet row object.

Show Source

• object ApiEntityCBSSheetRowInput
  Title: ApiEntityCBSSheetRowInput

{
    "description":"A CBS sheet row object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityCBSSheetRowInput"
        }
    ]
}

Nested Schema : parentCBSCodes

Type: array

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

Nested Schema : ApiEntityCBSSheetRowInput

Type: object

Title: ApiEntityCBSSheetRowInput

Show Source

• configuredFields: array configuredFields
  An object containing configured fields in the form of key-value pairs.

{
    "title":"ApiEntityCBSSheetRowInput",
    "type":"object",
    "properties":{
        "configuredFields":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCBSSheetRowConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

An object containing configured fields in the form of key-value pairs.

Show Source

• Array of: object ApiEntityCBSSheetRowConfiguredFieldValueInput
  Title: ApiEntityCBSSheetRowConfiguredFieldValueInput

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

  • costSheetRowConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

{
    "type":"array",
    "description":"An object containing configured fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCBSSheetRowConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCBSSheetRowConfiguredFieldValueInput

Type: object

Title: ApiEntityCBSSheetRowConfiguredFieldValueInput

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

• costSheetRowConfiguredFieldValueId
• 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.
• costSheetRowConfiguredFieldValueId: integer (int64)
  The unique identifier for the Project Cost Sheet Configured Field.
• costSheetRowId: integer (int64)
  The system-generated identifier of a CBS Code.
• 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":"ApiEntityCBSSheetRowConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "costSheetRowId":{
            "type":"integer",
            "description":"The system-generated identifier of a CBS Code.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costSheetRowConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Project Cost Sheet 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 CBSSheetRowConfiguredFieldValue object, a unique CBSSheetRowConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>costSheetRowConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create or Update CBSs

Back to Top

Response

Supported Media Types

• application/json

200 Response

The object was successfully updated.

Body ()

Root 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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "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 : 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":{
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "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 : 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"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

201 Response

The object was successfully created.

Body ()

Root 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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "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 : 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":{
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "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 : 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"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid Input.

Back to Top