Jump to

• Request
• Response
• Examples

Create a project process configurator

post

/fscmRestApi/resources/11.13.18.05/projectProcessConfigurators

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{ "required":[ "ActiveFlag", "BusinessProcess", "BusinessProcessCode", "Name", "UserConfiguration" ], "type":"object", "properties":{ "SourceAsgnmts":{ "title":"Source Assignments", "type":"array", "description":"The Source Assignments resource is used to view, create, update a Source for a configurator.", "items":{ "$ref":"#/components/schemas/projectProcessConfigurators-SourceAsgnmts-item-post-request" } }, "ConfiguratorId":{ "title":"Configurator ID", "type":"integer", "description":"Unique identifier for a configurator.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" } }, "BusinessProcessCode":{ "title":"Business Process Code", "maxLength":30, "type":"string", "description":"Indicates the code for the business process for which the project configurator is created.", "nullable":false }, "ActiveFlag":{ "title":"Active", "maxLength":30, "type":"boolean", "description":"Indicates if a project configurator is active.", "nullable":false }, "BusinessProcess":{ "title":"Business Process", "maxLength":80, "type":"string", "description":"Indicates the name for the business process for which the project configurator is created.", "nullable":false, "x-hints":{ "controlType":"combo_lov" } }, "Name":{ "title":"Name", "maxLength":240, "type":"string", "description":"Name of the configurator entered by the user.", "nullable":false }, "UserConfiguration":{ "title":"Configurator", "maxLength":2000, "type":"string", "description":"The expression created for the configurator on which the processing is performed.", "nullable":false, "x-queryable":false } } }

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

• Array of: object schema

{ "title":"Source Assignments", "type":"array", "description":"The Source Assignments resource is used to view, create, update a Source for a configurator.", "items":{ "$ref":"#/components/schemas/projectProcessConfigurators-SourceAsgnmts-item-post-request" } }

Nested Schema : schema

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "UserFilter":{ "title":"Filter", "maxLength":2000, "type":"string", "description":"The user entered filter for the configurator source assignment.", "nullable":true, "x-queryable":false }, "SourceAssignmentId":{ "title":"Source Assignment ID", "type":"integer", "description":"Unique identifier for configurator source assignment.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" } }, "SourceName":{ "title":"Source Name", "maxLength":120, "type":"string", "description":"Indicates the name for the configurator source.", "nullable":false, "x-hints":{ "controlType":"combo_lov" } }, "ConfiguratorId":{ "title":"Configurator ID", "type":"integer", "description":"Unique identifier for a configurator.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 } }, "Alias":{ "title":"Alias", "maxLength":80, "type":"string", "description":"The user provided alias for each configurator source assignment.", "nullable":false } } }

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : projectProcessConfigurators-item-response

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "LastUpdatedBy":{ "title":"Last Updated By", "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":false }, "CreationDate":{ "title":"Creation Date", "type":"string", "description":"The date when the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":false }, "SourceAsgnmts":{ "title":"Source Assignments", "type":"array", "description":"The Source Assignments resource is used to view, create, update a Source for a configurator.", "items":{ "$ref":"#/components/schemas/projectProcessConfigurators-SourceAsgnmts-item-response" } }, "CreatedBy":{ "title":"Created By", "maxLength":64, "type":"string", "description":"The user who created the configurator.", "nullable":false, "readOnly":true, "x-queryable":false }, "ConfiguratorId":{ "title":"Configurator ID", "type":"integer", "description":"Unique identifier for a configurator.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "BusinessProcessCode":{ "title":"Business Process Code", "maxLength":30, "type":"string", "description":"Indicates the code for the business process for which the project configurator is created.", "nullable":false, "x-queryable":true }, "ActiveFlag":{ "title":"Active", "maxLength":30, "type":"boolean", "description":"Indicates if a project configurator is active.", "nullable":false, "x-queryable":true }, "LastUpdateDate":{ "title":"Last Updated Date", "type":"string", "description":"The date when the record was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":false }, "BusinessProcess":{ "title":"Business Process", "maxLength":80, "type":"string", "description":"Indicates the name for the business process for which the project configurator is created.", "nullable":false, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "Name":{ "title":"Name", "maxLength":240, "type":"string", "description":"Name of the configurator entered by the user.", "nullable":false, "x-queryable":true }, "UserConfiguration":{ "title":"Configurator", "maxLength":2000, "type":"string", "description":"The expression created for the configurator on which the processing is performed.", "nullable":false, "x-queryable":false } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

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

• Array of: object projectProcessConfigurators-SourceAsgnmts-item-response

{ "title":"Source Assignments", "type":"array", "description":"The Source Assignments resource is used to view, create, update a Source for a configurator.", "items":{ "$ref":"#/components/schemas/projectProcessConfigurators-SourceAsgnmts-item-response" } }

Nested Schema : link

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "kind":{ "title":"kind", "type":"string", "description":"The kind of the related resource.", "enum":[ "collection", "item", "describe", "other" ] }, "rel":{ "title":"relation", "type":"string", "description":"The name of the relation to the resource instance. Example: self.", "enum":[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ] }, "name":{ "title":"name", "type":"string", "description":"The name of the link to the related resource." }, "href":{ "title":"hyperlink reference", "type":"string", "description":"The URI to the related resource." }, "properties":{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } } } }

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{ "type":"object", "properties":{ "changeIndicator":{ "type":"string", "description":"Change indicator or the ETag value of the resource instance." } } }

Nested Schema : projectProcessConfigurators-SourceAsgnmts-item-response

Type: object

Show Source

• 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.

{ "type":"object", "properties":{ "LastUpdatedBy":{ "title":"Last Updated By", "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":false }, "CreationDate":{ "title":"Creation Date", "type":"string", "description":"The date when the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":false }, "CreatedBy":{ "title":"Created By", "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":false }, "ConfiguratorId":{ "title":"Configurator ID", "type":"integer", "description":"Unique identifier for a configurator.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "Alias":{ "title":"Alias", "maxLength":80, "type":"string", "description":"The user provided alias for each configurator source assignment.", "nullable":false, "x-queryable":true }, "UserFilter":{ "title":"Filter", "maxLength":2000, "type":"string", "description":"The user entered filter for the configurator source assignment.", "nullable":true, "x-queryable":false }, "SourceAssignmentId":{ "title":"Source Assignment ID", "type":"integer", "description":"Unique identifier for configurator source assignment.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "SourceName":{ "title":"Source Name", "maxLength":120, "type":"string", "description":"Indicates the name for the configurator source.", "nullable":false, "x-hints":{ "controlType":"combo_lov" }, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "LastUpdateDate":{ "title":"Last Updated Date", "type":"string", "description":"The date when the record was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":false } } }

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }

Links

SourceAsgnmts

Operation: /fscmRestApi/resources/11.13.18.05/projectProcessConfigurators/{ConfiguratorId}/child/SourceAsgnmts

Parameters:

• ConfiguratorId: $request.path.ConfiguratorId

The Source Assignments resource is used to view, create, update a Source for a configurator.

Back to Top

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" } ] }

Back to Top