Batch Integrate Projects with an External Data Source

post

/primeapi/restapi/project/syncBatch

Send a request to this endpoint to create or update one or more integrated projects with an external data source.

Request

Supported Media Types
Body ()
The unique identifier of project data in an external source.S
Root Schema : List<ApiEntityExternallySourcedProject>
Type: array
Title: List<ApiEntityExternallySourcedProject>
Show Source
Nested Schema : ApiEntityExternallySourcedProject
Type: object
Show Source
Nested Schema : Duration
Type: object
Show Source
Nested Schema : codeValuesProject
Type: array
Unique Items Required: true
The categories of a project.
Show Source
Nested Schema : Percent
Type: object
Show Source
Nested Schema : ApiEntityProjectImage
Type: object
Show Source
Nested Schema : projectAutoNumber
Type: array
Read Only: true
Unique Items Required: true
The autonumber settings of a project.
Show Source
Nested Schema : projectCashFlows
Type: array
The cash flow of a project.
Show Source
Nested Schema : ApiEntityProjectConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityProjectFinancial
Type: object
Show Source
Nested Schema : projectSettings
Type: array
Read Only: true
Unique Items Required: true
Show Source
Nested Schema : Unit
Type: object
Nested Schema : ApiEntityCodeValueProject
Type: object
Show Source
Nested Schema : ApiEntityCodeType
Type: object
Show Source
Nested Schema : ApiEntityCodeValue
Type: object
Show Source
Nested Schema : assignments
Type: array
Unique Items Required: true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type: object
Show Source
  • ApiEntityCodeType
  • Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
    Indicates the type of object the code is associated to.
  • The unique identifier of a code type table.
  • Read Only: true
    The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : image
Type: array
The image file uploaded to the project.
Displayed throughout the application in areas like news feeds.
Show Source
Nested Schema : ApiEntityProjectAutoNumber
Type: object
Show Source
  • Allowed Values: [ "ACTIVITY", "ACTIVITY_ASSIGNMENT", "SCOPE_ITEM", "SCOPE_ASSIGNMENT", "CHANGE_ITEM", "WORK_PACKAGE", "CHANGE_REQUEST", "CONTRACT", "COMMITMENT", "BUDGET_CHANGE", "BUDGET_TRANSFER" ]
    Identifies the type of object used for auto numbering.
  • The number to increment the starting number by.
  • This is an internal field.
  • Allowed Values: [ "Length[1-20]" ]
    The initial characters for the auto numbering sequence.
  • The auto generated ID for the object.
  • The first number in the auto numbering sequence.
  • Read Only: true
    The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : ApiEntityProjectCashFlow
Type: object
Show Source
Nested Schema : Cost
Type: object
Nested Schema : costFlexMap
Type: object
Additional Properties Allowed
Show Source
The cost fields associated with a project.
Nested Schema : otherFlexMap
Type: object
Additional Properties Allowed
Show Source
The non-cost and non-text fields associated with a project.
Nested Schema : ApiEntityProject
Type: object
Show Source
Nested Schema : textFlexMap
Type: object
Additional Properties Allowed
Show Source
The text fields associated with a project.
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : codeValuesProject
Type: array
Unique Items Required: true
The categories of a project.
Show Source
Nested Schema : projectAutoNumber
Type: array
Read Only: true
Unique Items Required: true
The autonumber settings of a project.
Show Source
Nested Schema : projectCashFlows
Type: array
The cash flow of a project.
Show Source
Nested Schema : projectSettings
Type: array
Read Only: true
Unique Items Required: true
Show Source
Nested Schema : ApiEntityProjectSetting
Type: object
Show Source
Nested Schema : additionalProperties
Type: object

Response

Supported Media Types

207 Response

Successful Sync Operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ApiEntityERPSyncApiResponse
Type: object
Show Source

400 Response

Invalid input for the Project service.