Jump to

• Request
• Response

Integrate Project Actuals Data with an External Data Source

post

/api/restapi/projectActuals/sync

Send a request to this endpoint to create or update an integrated project actuals data. 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 : ApiEntityExternallySourcedProjectActualsInput

Type: object

Title: ApiEntityExternallySourcedProjectActualsInput

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

• projectActualsId
• projectActualsCode,projectId
• projectActualsCode,projectCode,workspaceCode

Show Source

• approvedByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The username of the user who approved the item.
• approvedDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  The date that the actual was approved.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a company.
• companySourceId: string
  Maximum Length: 255

  The unique identifier of company data in an external source.
• configuredFields: array configuredFields
  The list of configured fields for a project actuals.
• confirmedByEmailAddress: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  Indicates whether or not the project actual has been confirmed via email.
• currencyCode: string
  Minimum Length: 1

  Maximum Length: 3

  The user-specified identifier of a currency.
• currencyId: integer (int64)
  The system-generated identifier of the currency associated with the project actual.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Details about the project actual.
• effectiveDate: string (date-time)
  The date the actual is effective.
• fixedExchangeRate: number
  The exchange rate used to convert the Total Amount value from the record currency to the base currency.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectActualName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the actual.
• projectActualsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for an actual.
• projectActualsCost: projectActualsCost
  An object containing cost fields in the form of key-value pairs.
• projectActualsId: integer (int64)
  The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• projectCompanyId: integer (int64)
  The name of the company associated with the actual.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• projectSourceId: string
  Maximum Length: 255

  The unique identifier of project data in an external source.
• sourceId: string
  Maximum Length: 255

  The unique identifier of project actual data in an external source.

  Example: coarse
• status: string
  Allowed Values: [ "PENDING", "CONFIRMED" ]

  That status of the actual. Valid values are Pending and Confirmed.
• totalHours: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• withdrawByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The system-generated identifier of the user who withdrew confirmation of the project actual.
• withdrawConfirmedByEmailAddress: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  Indicates whether or not the actual withdrawl has been confirmed via email.
• withdrawDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  The date that confirmation of the project actual was withdrawn.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityExternallySourcedProjectActualsInput",
    "required":[
        "projectActualName",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyCode":{
            "maxLength":"3",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"That status of the actual. Valid values are Pending and Confirmed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "CONFIRMED"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Details about the project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date the actual is effective.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a project actuals.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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 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"
            ]
        },
        "approvedDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The date that the actual was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fixedExchangeRate":{
            "type":"number",
            "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "sourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project actual data in an external source.",
            "example":"coarse",
            "exampleSetFlag":true,
            "types":[
                "string"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The name of the company associated with the actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The system-generated identifier of the currency associated with the project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The date that confirmation of the project actual was withdrawn.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "totalHours":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "projectActualsCost":{
            "description":"An object containing cost fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput"
                }
            ]
        },
        "withdrawByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of the user who withdrew confirmation of the project actual.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approvedByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The username of the user who approved the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "confirmedByEmailAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether or not the project actual has been confirmed via email.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawConfirmedByEmailAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether or not the actual withdrawl has been confirmed via email.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectSourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companySourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of company data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for an actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ExternallySourcedProjectActuals object, a unique ExternallySourcedProjectActuals object can be identified by the following combinations of the fields.<ul><li>projectActualsId</li><li>projectActualsCode,projectId</li><li>projectActualsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a project actuals.

Show Source

• Array of: object ApiEntityProjectActualsConfiguredFieldValueInput
  Title: ApiEntityProjectActualsConfiguredFieldValueInput

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

  • projectActualsConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : projectActualsCost

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

Match All

Show Source

• object ApiEntityProjectActualsCostInput
  Title: ApiEntityProjectActualsCostInput

{
    "description":"An object containing cost fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput"
        }
    ]
}

Nested Schema : ApiEntityProjectActualsConfiguredFieldValueInput

Type: object

Title: ApiEntityProjectActualsConfiguredFieldValueInput

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

• projectActualsConfiguredFieldValueId
• 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.
• costValue: number
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueProject: number (double)
  Deprecated. As of 23.11.
  This holds value of Cost type configured fields in the project level currency conversion. Input should be provided in numberValue field, in project actuals record level currency.
• costValueWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.10.
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Read Only: true

  Maximum Length: 4000

  Deprecated. As of 23.10.
  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Read Only: true

  Deprecated. As of 23.10.
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• projectActualsConfiguredFieldValueId: integer (int64)
  The unique identifier for the Project Actuals Configured Field.
• projectActualsId: integer (int64)
  The system-generated identifier for an Actual.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProjectActualsConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Project Actuals Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costValueProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>This holds value of Cost type configured fields in the project level currency conversion. Input should be provided in numberValue field, in project actuals record level currency.",
            "format":"double",
            "deprecated":true,
            "exampleSetFlag":false
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The system-generated identifier for an Actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        },
        "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"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Determines if formula calculation hit an error calculating a value for this field.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Provides the error message for why the formula calculation resulted in an error.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "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 ProjectActualsConfiguredFieldValue object, a unique ProjectActualsConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>projectActualsConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectActualsCostInput

Type: object

Title: ApiEntityProjectActualsCostInput

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectActuals: projectActuals
  The supporting details for the project actuals.
• projectActualsId: integer (int64)
  The unique identifier of project actual data.
• totalAmount: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  Total Amount is calculated as the sum of the Amount of each actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalAmountProject field based on the specified exchange rate.
• totalAmountProject: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the project currency.
• totalAmountProjectActuals: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the record level currency.
• totalAmountWorkspace1: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace1 currency.
• totalAmountWorkspace2: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace2 currency.
• totalAmountWorkspace3: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityProjectActualsCostInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier of project actual data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActuals":{
            "description":"The supporting details for the project actuals. ",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsInput"
                }
            ]
        },
        "totalAmount":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Total Amount is calculated as the sum of the Amount of each actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalAmountProject field based on the specified exchange rate.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "totalAmountProject":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the project currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "totalAmountWorkspace1":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace1 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "totalAmountWorkspace2":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace2 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "totalAmountWorkspace3":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace3 currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "totalAmountProjectActuals":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the record level currency.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectActuals

The supporting details for the project actuals.

Match All

Show Source

• object ApiEntityProjectActualsInput
  Title: ApiEntityProjectActualsInput

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

  • projectActualsId
  • projectActualsCode,projectId
  • projectActualsCode,projectCode,workspaceCode

{
    "description":"The supporting details for the project actuals. ",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsInput"
        }
    ]
}

Nested Schema : ApiEntityProjectActualsInput

Type: object

Title: ApiEntityProjectActualsInput

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

• projectActualsId
• projectActualsCode,projectId
• projectActualsCode,projectCode,workspaceCode

Show Source

• approvedByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The username of the user who approved the item.
• approvedDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  The date that the actual was approved.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a company.
• companySourceId: string
  Maximum Length: 255

  The unique identifier of company data in an external source.
• configuredFields: array configuredFields
  The list of configured fields for a project actuals.
• confirmedByEmailAddress: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  Indicates whether or not the project actual has been confirmed via email.
• currencyCode: string
  Minimum Length: 1

  Maximum Length: 3

  The user-specified identifier of a currency.
• currencyId: integer (int64)
  The system-generated identifier of the currency associated with the project actual.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Details about the project actual.
• effectiveDate: string (date-time)
  The date the actual is effective.
• fixedExchangeRate: number
  The exchange rate used to convert the Total Amount value from the record currency to the base currency.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectActualName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the actual.
• projectActualsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for an actual.
• projectActualsCost: projectActualsCost
  An object containing cost fields in the form of key-value pairs.
• projectActualsId: integer (int64)
  The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• projectCompanyId: integer (int64)
  The name of the company associated with the actual.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• projectSourceId: string
  Maximum Length: 255

  The unique identifier of project data in an external source.
• sourceId: string
  Maximum Length: 255

  The unique identifier of project actual data in an external source.

  Example: coarse
• status: string
  Allowed Values: [ "PENDING", "CONFIRMED" ]

  That status of the actual. Valid values are Pending and Confirmed.
• totalHours: number (double)
  Read Only: true

  Deprecated. As of 23.11.
  Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• withdrawByUserId: integer (int64)
  Read Only: true

  Deprecated. As of 23.11.
  The system-generated identifier of the user who withdrew confirmation of the project actual.
• withdrawConfirmedByEmailAddress: string
  Read Only: true

  Maximum Length: 255

  Deprecated. As of 23.11.
  Indicates whether or not the actual withdrawl has been confirmed via email.
• withdrawDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.11.
  The date that confirmation of the project actual was withdrawn.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityProjectActualsInput",
    "required":[
        "projectActualName",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyCode":{
            "maxLength":"3",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"That status of the actual. Valid values are Pending and Confirmed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "CONFIRMED"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Details about the project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date the actual is effective.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a project actuals.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "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 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"
            ]
        },
        "approvedDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The date that the actual was approved.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fixedExchangeRate":{
            "type":"number",
            "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "sourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project actual data in an external source.",
            "example":"coarse",
            "exampleSetFlag":true,
            "types":[
                "string"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The name of the company associated with the actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The system-generated identifier of the currency associated with the project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The date that confirmation of the project actual was withdrawn.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "totalHours":{
            "type":"number",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.",
            "format":"double",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false
        },
        "projectActualsCost":{
            "description":"An object containing cost fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput"
                }
            ]
        },
        "withdrawByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The system-generated identifier of the user who withdrew confirmation of the project actual.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approvedByUserId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>The username of the user who approved the item.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "confirmedByEmailAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether or not the project actual has been confirmed via email.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawConfirmedByEmailAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.11</i>.</br>Indicates whether or not the actual withdrawl has been confirmed via email.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectSourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companySourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of company data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for an actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.<ul><li>projectActualsId</li><li>projectActualsCode,projectId</li><li>projectActualsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a project actuals.

Show Source

• Array of: object ApiEntityProjectActualsConfiguredFieldValueInput
  Title: ApiEntityProjectActualsConfiguredFieldValueInput

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

  • projectActualsConfiguredFieldValueId
  • columnDefinitionId
  • columnName
  • columnLabel

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

Nested Schema : projectActualsCost

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

Match All

Show Source

• object ApiEntityProjectActualsCostInput
  Title: ApiEntityProjectActualsCostInput

{
    "description":"An object containing cost fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsCostInput"
        }
    ]
}

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"
            ]
        },
        "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":{
        "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of a parent cost item in a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : 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
}

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"
            ]
        },
        "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":{
        "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of a parent cost item in a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : 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