Integrate a Resource with an External Data Source

post

/primeapi/restapi/resource/sync

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

Supported Media Types
Body ()
The unique identifier of resource data in an external source.
Root Schema : ApiEntityExternallySourcedResource
Type: object
Show Source
Nested Schema : codeValuesResource
Type: array
Unique Items Required: true
An array of code values for this resource object.
Show Source
Nested Schema : Unit
Type: object
Nested Schema : resourceRoleAssignments
Type: array
The role assignment associated with the resource.
Show Source
Nested Schema : resourceWorkRates
Type: array
The work rates of the resource.
Show Source
Nested Schema : ApiEntityExternallySourcedUser
Type: object
Show Source
Nested Schema : ApiEntityCodeValueResource
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 : ApiEntityResourceRoleAssignment
Type: object
Show Source
  • Default Value: false
    Determines whether this is the resource's main role. A role that does not have this option selected indicates that this is a secondary role for the resource. You can only assign one primary role per resource. A resource is not required to have a primary role.
  • Allowed Values: [ "ONE", "TWO", "THREE", "FOUR", "FIVE" ]
    The skill level of the resource.
    Skill levels are Master, Expert, Skilled, Proficient, and Inexperienced.
  • The unique identifier for the resource or role.
  • The identifier for the resource.
  • The unique identifier for the resource or role.
  • The unique identifier for the resource or role.
  • 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 : ApiEntityResourceWorkRate
Type: object
Show Source

Response

Supported Media Types

200 Response

Successful Update Operation.
Body ()
Root Schema : ApiEntityERPSyncApiResponse
Type: object
Show Source

201 Response

Successful Create Operation.
Body ()
Root Schema : ApiEntityERPSyncApiResponse
Type: object
Show Source

400 Response

Invalid Input.