Create a project process configurator
post
/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag(required): boolean
Title:
Active
Maximum Length:30
Indicates if a project configurator is active. -
BusinessProcess(required): string
Title:
Business Process
Maximum Length:80
Indicates the name for the business process for which the project configurator is created. -
BusinessProcessCode(required): string
Title:
Business Process Code
Maximum Length:30
Indicates the code for the business process for which the project configurator is created. -
ConfiguratorId: integer
(int64)
Title:
Configurator ID
Unique identifier for a configurator. -
Name(required): string
Title:
Name
Maximum Length:240
Name of the configurator entered by the user. -
SourceAsgnmts: array
Source Assignments
Title:
Source Assignments
The Source Assignments resource is used to view, create, update a Source for a configurator. -
UserConfiguration(required): string
Title:
Configurator
Maximum Length:2000
The expression created for the configurator on which the processing is performed.
Nested Schema : Source Assignments
Type:
array
Title:
Source Assignments
The Source Assignments resource is used to view, create, update a Source for a configurator.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Alias: string
Title:
Alias
Maximum Length:80
The user provided alias for each configurator source assignment. -
ConfiguratorId: integer
(int64)
Title:
Configurator ID
Unique identifier for a configurator. -
SourceAssignmentId: integer
(int64)
Title:
Source Assignment ID
Unique identifier for configurator source assignment. -
SourceName: string
Title:
Source Name
Maximum Length:120
Indicates the name for the configurator source. -
UserFilter: string
Title:
Filter
Maximum Length:2000
The user entered filter for the configurator source assignment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectProcessConfigurators-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:30
Indicates if a project configurator is active. -
BusinessProcess: string
Title:
Business Process
Maximum Length:80
Indicates the name for the business process for which the project configurator is created. -
BusinessProcessCode: string
Title:
Business Process Code
Maximum Length:30
Indicates the code for the business process for which the project configurator is created. -
ConfiguratorId: integer
(int64)
Title:
Configurator ID
Unique identifier for a configurator. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the configurator. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:240
Name of the configurator entered by the user. -
SourceAsgnmts: array
Source Assignments
Title:
Source Assignments
The Source Assignments resource is used to view, create, update a Source for a configurator. -
UserConfiguration: string
Title:
Configurator
Maximum Length:2000
The expression created for the configurator on which the processing is performed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Source Assignments
Type:
array
Title:
Source Assignments
The Source Assignments resource is used to view, create, update a Source for a configurator.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : projectProcessConfigurators-SourceAsgnmts-item-response
Type:
Show Source
object
-
Alias: string
Title:
Alias
Maximum Length:80
The user provided alias for each configurator source assignment. -
ConfiguratorId: integer
(int64)
Title:
Configurator ID
Unique identifier for a configurator. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceAssignmentId: integer
(int64)
Title:
Source Assignment ID
Unique identifier for configurator source assignment. -
SourceName: string
Title:
Source Name
Maximum Length:120
Indicates the name for the configurator source. -
UserFilter: string
Title:
Filter
Maximum Length:2000
The user entered filter for the configurator source assignment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SourceAsgnmts
-
Operation: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}/child/SourceAsgnmtsParameters:
- ConfiguratorId:
$request.path.ConfiguratorId
The Source Assignments resource is used to view, create, update a Source for a configurator. - ConfiguratorId:
Examples
The following example shows how to create a project process configurator by submitting a POST request on the REST resource using cURL.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators
Request Body Example
The following shows an example of the request body in JSON format.
{ "ActiveFlag": true, "Name": "Batch102", "UserConfiguration": "( \"CalculationLevelEventRevenueinContractCurrencyITD\"/ \"ContractEventRevenueinContractCurrencyITD\") * 100", "BusinessProcess": "Project Revenue", "SourceAsgnmts": [ { "Alias": "CalculationLevelEventRevenueinContractCurrencyITD", "UserFilter": "\"Event Type\" = '' 'AND' \"Revenue Category\" = ''", "SourceName": "Calculation Level Event Revenue in Contract Currency - ITD" }, { "Alias": "ContractEventRevenueinContractCurrencyITD", "UserFilter": "\"Event Type\" = ''", "SourceName": "Contract Event Revenue in Contract Currency - ITD" } ] }
Response Body Example
The following shows an example of the response body in JSON format.
{ "ConfiguratorId": 300100175275124, "ActiveFlag": true, "BusinessProcessCode": "PJB_REVENUE", "CreatedBy": "ABRAHAM.MASON", "CreationDate": "2019-03-04T10:07:21+00:00", "LastUpdateDate": "2019-03-04T10:07:21.336+00:00", "LastUpdatedBy": "ABRAHAM.MASON", "Name": "Batch102", "UserConfiguration": "( \"CalculationLevelEventRevenueinContractCurrencyITD\"/ \"ContractEventRevenueinContractCurrencyITD\") * 100", "BusinessProcess": null, "SourceAsgnmts": [ { "SourceAssignmentId": 300100175275125, "Alias": "CalculationLevelEventRevenueinContractCurrencyITD", "ConfiguratorId": 300100175275124, "CreatedBy": "ABRAHAM.MASON", "CreationDate": "2019-03-04T10:07:21.222+00:00", "LastUpdateDate": "2019-03-04T10:07:21.337+00:00", "LastUpdatedBy": "ABRAHAM.MASON", "UserFilter": "\"Event Type\" = '' 'AND' \"Revenue Category\" = ''", "SourceName": "Calculation Level Event Revenue in Contract Currency - ITD", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/child/SourceAsgnmts/300100175275125", "name": "SourceAsgnmts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/child/SourceAsgnmts/300100175275125", "name": "SourceAsgnmts", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124", "name": "projectProcessConfigurators", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/child/SourceAsgnmts/300100175275125/lov/ConfiguratorSourcesVA", "name": "ConfiguratorSourcesVA", "kind": "collection" } ] }, { "SourceAssignmentId": 300100175275126, "Alias": "ContractEventRevenueinContractCurrencyITD", "ConfiguratorId": 300100175275124, "CreatedBy": "ABRAHAM.MASON", "CreationDate": "2019-03-04T10:07:21.265+00:00", "LastUpdateDate": "2019-03-04T10:07:21.337+00:00", "LastUpdatedBy": "ABRAHAM.MASON", "UserFilter": "\"Event Type\" = ''", "SourceName": "Contract Event Revenue in Contract Currency - ITD", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/child/SourceAsgnmts/300100175275126", "name": "SourceAsgnmts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/child/SourceAsgnmts/300100175275126", "name": "SourceAsgnmts", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124", "name": "projectProcessConfigurators", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/child/SourceAsgnmts/300100175275126/lov/ConfiguratorSourcesVA", "name": "ConfiguratorSourcesVA", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124", "name": "projectProcessConfigurators", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124", "name": "projectProcessConfigurators", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/lov/BusinessProcessVA", "name": "BusinessProcessVA", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/300100175275124/child/SourceAsgnmts", "name": "SourceAsgnmts", "kind": "collection" } ] }