1. Oracle Primavera Cloud REST API
  2. Tasks
  3. Resource

Batch Integrate Resources with an External Data Source

post

/api/restapi/resource/syncBatch

Send a request to this endpoint to create or update one or more integrated resources. 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

Header Parameters
  • Enabling this boolean flag will fail the request if an error occurs while processing any resource sent as part of the request.
    Allowed Values: [ "true", "false" ]
    Default Value: false
Supported Media Types
Request Body - application/json ()
Root Schema : List<ApiEntityExternallySourcedResourceInput>
Type: array
Title: List<ApiEntityExternallySourcedResourceInput>
Show Source
  • ApiEntityExternallySourcedResourceInput
    Title: ApiEntityExternallySourcedResourceInput
    This entity represents a ExternallySourcedResource object, a unique ExternallySourcedResource object can be identified by the following combinations of the fields.
    • resourceId
    • resourceCode,resourceClass,workspaceId
    • resourceCode,resourceClass,workspaceCode
    • resourceCode,resourceClass,projectId
    • resourceCode,resourceClass,projectCode,workspaceCode
Nested Schema : ApiEntityExternallySourcedResourceInput
Type: object
Title: ApiEntityExternallySourcedResourceInput
This entity represents a ExternallySourcedResource object, a unique ExternallySourcedResource object can be identified by the following combinations of the fields.
  • resourceId
  • resourceCode,resourceClass,workspaceId
  • resourceCode,resourceClass,workspaceCode
  • resourceCode,resourceClass,projectId
  • resourceCode,resourceClass,projectCode,workspaceCode
Show Source
  • Minimum Length: 0
    Maximum Length: 200
    The first line of the address of a location.
    This might be the building number and street address.
  • Minimum Length: 0
    Maximum Length: 200
    The second line of the address of a location.
    This might be a neighborhood or town.
  • The name of the user in the application that is also a resource.
  • Read Only: true
    Allowed Values: [ "OWNED", "INHERITED" ]
    Deprecated. As of 24.4.
    The type of association in the relationship between the resource and the workspace. Possible values are Owned and Inherited.
  • The calendar assigned to the resource or role.
  • Minimum Length: 0
    Maximum Length: 255
    The unique code for the calendar.
  • Read Only: true
    Minimum Length: 0
    Maximum Length: 255
    Deprecated. As of 24.4.
    The name of the calendar.
  • Minimum Length: 0
    Maximum Length: 200
    The city name for a location.
  • codeValuesResource
    The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.
  • Allowed Values: [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ]
    The type of costs associated with a resource.
  • Minimum Length: 0
    Maximum Length: 3
    The country for a location.
  • The default unit/time is the maximum work units per time a resource or role can perform on all their assigned activities. The value is shown as either a percentage or units/duration depending on the user settings. If the Resource Type is Material, then units/duration are always displayed.
    For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day, which is represented as 100%.
  • Minimum Length: 0
    Maximum Length: 4000
    Additional information for the resource or the role.
  • Minimum Length: 0
    Maximum Length: 255
    The email address for the resource.
  • Minimum Length: 0
    Maximum Length: 60
    The resource identifier within the organization, typically the employee number or social security number.
  • Indicates whether or not this resource is an application user.
  • Minimum Value: -90
    Maximum Value: 90
    The geographical coordinate for the latitude of the location.
    The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
  • 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.
  • Minimum Value: -180
    Maximum Value: 180
    The geographical coordinate for the longitude of the location.
    The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
  • Maximum Length: 255
    The name of the manager associated with the resource.
  • Minimum Length: 0
    Maximum Length: 32
    The office phone number for the resource.
  • Minimum Length: 0
    Maximum Length: 32
    The alternate phone numbers for the resource.
  • The overtime factor used to compute the overtime price for the resource.
  • The unique identifier for the parent resource or role.
  • Minimum Length: 1
    Maximum Length: 60
    The parent resource code of a resource.
  • Minimum Length: 0
    Maximum Length: 20
    The postal code, post code, or zip code of a location.
  • Read Only: true
    Allowed Values: [ "OWNED", "INHERITED" ]
    Deprecated. As of 24.4.
    The type of association in the relationship between the resource and the project. Possible values are Owned and Inherited.
  • Maximum Length: 60
    The unique identifier for a project set by the user who created the project.
  • The unique identifier for the project.
  • Allowed Values: [ "RESOURCE", "ROLE" ]
    The class identifies the item as a resource or a role.
  • Minimum Length: 1
    Maximum Length: 60
    The unique identifier for the resource or role.
  • The unique identifier for the resource or role.
  • The person designated as the manager for the resource.
  • Minimum Length: 1
    Maximum Length: 255
    The name of the resource or role.
  • Allowed Values: [ "WORKSPACE", "PROJECT" ]
    The type of ownership for a resource. Possible values include Workspace and Project.
  • resourceRoleAssignments
    The role assignment associated with the resource.
  • The identifier for the role assigned to the resource.
  • Allowed Values: [ "ACTIVE", "INACTIVE" ]
    Determines whether the resource or role is currently active.
    Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours.
  • Minimum Length: 0
    Maximum Length: 255
    The job title for the resource.
    For example, a resource may have the title Senior Engineer.
  • Allowed Values: [ "LABOR", "NONLABOR", "MATERIAL" ]
    The resource type. Valid values are:
    Labor: Indicates that the selected resource performs labor, measured in units of time.
    Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
    Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.
  • resourceWorkRates
    The work rates of the resource.
  • Maximum Length: 255
    The unique identifier of resource data in an external source.
  • Minimum Length: 0
    Maximum Length: 2
    A unique identifier for the state or province.
  • Minimum Length: 0
    Maximum Length: 200
    The state, region, or province of a location.
  • Minimum Length: 0
    Maximum Length: 60
    The abbreviation for the unit of measure name.
  • The unit of measure used for the material resource.
  • Read Only: true
    Deprecated. As of 24.4.
    Date when the record was last updated.
  • user
    The user associated with the resource.
  • Minimum Length: 0
    Maximum Length: 60
    The user-specified identifier of a workspace.
  • The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
  • Read Only: true
    Minimum Length: 1
    Maximum Length: 255
    Deprecated. As of 24.4.
    Name of a workspace.
Nested Schema : codeValuesResource
Type: array
The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
  • ApiEntityCodeValueResourceInput
    Title: ApiEntityCodeValueResourceInput
    This entity represents a CodeValueResource object, a unique CodeValueResource object can be identified by the following combinations of the fields.
    • codeValueResourceId
    • codeValueId
    • codeTypeId,codeValueCode
    • codeTypeCode,codeValueCode
    • codeTypeCode,parentId,codeValueCode
    • codeValueCode,codeTypeId,parentId
    • codeTypeCode,codeValueCode,projectCode
    • codeTypeCode,codeValueCode,projectId
    • codeTypeCode,codeValueCode,parentId,projectCode
    • codeTypeCode,codeValueCode,parentId,projectId
Nested Schema : resourceRoleAssignments
Type: array
The role assignment associated with the resource.
Show Source
  • ApiEntityResourceRoleAssignmentInput
    Title: ApiEntityResourceRoleAssignmentInput
    This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.
    • resourceRoleAssignmentId
    • resourceId,roleId
    • resourceCode,workspaceCode,roleId
    • resourceId,workspaceCode,roleCode
    • resourceCode,workspaceCode,roleCode
Nested Schema : resourceWorkRates
Type: array
The work rates of the resource.
Show Source
  • ApiEntityResourceWorkRateInput
    Title: ApiEntityResourceWorkRateInput
    This entity represents a ResourceWorkRate object, a unique ResourceWorkRate object can be identified by the following combinations of the fields.
    • resourceWorkRateId
    • effectiveStartDate,workspaceResourceId
    • effectiveStartDate,resourceId,workspaceId
    • effectiveStartDate,resourceId,workspaceCode
    • effectiveStartDate,resourceCode,resourceClass,workspaceId
    • effectiveStartDate,resourceCode,resourceClass,workspaceCode
Nested Schema : user
The user associated with the resource.
Match All
Show Source
Nested Schema : ApiEntityCodeValueResourceInput
Type: object
Title: ApiEntityCodeValueResourceInput
This entity represents a CodeValueResource object, a unique CodeValueResource object can be identified by the following combinations of the fields.
  • codeValueResourceId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId
Show Source
Nested Schema : ApiEntityResourceRoleAssignmentInput
Type: object
Title: ApiEntityResourceRoleAssignmentInput
This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.
  • resourceRoleAssignmentId
  • resourceId,roleId
  • resourceCode,workspaceCode,roleId
  • resourceId,workspaceCode,roleCode
  • resourceCode,workspaceCode,roleCode
Show Source
Nested Schema : ApiEntityResourceWorkRateInput
Type: object
Title: ApiEntityResourceWorkRateInput
This entity represents a ResourceWorkRate object, a unique ResourceWorkRate object can be identified by the following combinations of the fields.
  • resourceWorkRateId
  • effectiveStartDate,workspaceResourceId
  • effectiveStartDate,resourceId,workspaceId
  • effectiveStartDate,resourceId,workspaceCode
  • effectiveStartDate,resourceCode,resourceClass,workspaceId
  • effectiveStartDate,resourceCode,resourceClass,workspaceCode
Show Source
Nested Schema : resourceWorkRateCost
An entity containing the price per unit fields of a resource work rate.
Match All
Show Source
Nested Schema : ApiEntityResourceWorkRateCostInput
Type: object
Title: ApiEntityResourceWorkRateCostInput
Show Source
  • Minimum Value: 0
    The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
  • Minimum Value: 0
    The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
  • Minimum Value: 0
    The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
  • Minimum Value: 0
    The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
  • Minimum Value: 0
    The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
  • The system-generated identifier of the work rate.
  • Read Only: true
    Deprecated. As of 23.10.
    Date when the record was last updated.
Nested Schema : ApiEntityExternallySourcedUser
Type: object
Title: ApiEntityExternallySourcedUser
Show Source
Nested Schema : userProducts
Type: array
A list of all user product fields and values in the form of key value pairs.
Show Source
Nested Schema : userSettings
Type: array
A list of all user setting fields and values in the form of key value pairs.
Show Source
Nested Schema : ApiEntityUserProduct
Type: object
Title: ApiEntityUserProduct
Show Source
Nested Schema : ApiEntityApplicationUserSetting
Type: object
Title: ApiEntityApplicationUserSetting
Show Source
  • The system-generated identifier of a user.
  • The unique identifier of a user's settings.
  • Read Only: true
    The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
  • Minimum Length: 1
    Maximum Length: 255
    The namespace to which a user is assigned.
  • Allowed Values: [ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ]
    The name of a user setting.
  • Minimum Length: 1
    Maximum Length: 4000
    The value of a user setting.
  • Read Only: true
    Date when the record was last updated.
Examples

Back to Top

Response

Supported Media Types

207 Response

The object was successfully integrated.
Body ()
Root Schema : List<ApiEntityERPSyncApiResponse>
Type: array
Title: List<ApiEntityERPSyncApiResponse>
Show Source
Nested Schema : ApiEntityERPSyncApiResponse
Type: object
Title: ApiEntityERPSyncApiResponse
Show Source
  • 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.
  • 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.
  • The primary key field name associated with the integrated object.
    The field is non-persistable and thus maximum length is not applicable.
  • The unique identifier for the integrated object.
  • Maximum Length: 255
    The unique identifier of the object in an external source.
  • The response code representing the state of the API operation.
  • Read Only: true
    Date when the record was last updated.
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
Nested Schema : ProjectIdentifier
Type: object
Title: ProjectIdentifier
Show Source
Nested Schema : CBSSheetCodeIdentifier
Type: object
Title: CBSSheetCodeIdentifier
Show Source
Nested Schema : ResourceIdentifier
Type: object
Title: ResourceIdentifier
Show Source

400 Response

Invalid Input.
Back to Top