Jump to

• Request
• Response
• Examples

Create

post

/fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramDFF

Request

Path Parameters

• projectProgramsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Project Programs resource and used to uniquely identify an instance of Project Programs. The client should not generate the hash key value. Instead, the client should query on the Project Programs collection resource in order to navigate to a specific instance of Project Programs to get the hash key.

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

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment

{ "type":"object", "properties":{ "__FLEX_Context_DisplayValue":{ "title":"Context Segment", "type":"string", "description":"Context Segment", "nullable":true, "x-hints":{ "updateable":"false", "DISPLAYHINT":"Hide", "FND_ACFF_IsReadOnly":"true", "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_ListDisplayAttrName":"Name", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } } }, "__FLEX_Context":{ "title":"Context Segment", "maxLength":30, "type":"string", "description":"Context Segment", "nullable":true, "x-hints":{ "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT", "controlType":"choice", "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue", "includeInCompactView":true, "FND_ACFF_IsDiscriminator":"true", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } } } } }

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 : projectPrograms-ProgramDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectProgramId: integer (int64)
  Title: Program ID

  Read Only: true

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "ProjectProgramId":{ "title":"Program ID", "type":"integer", "format":"int64", "nullable":false, "readOnly":true, "x-hints":{ "DISPLAYHINT":"Hide", "includeInCompactView":true, "precision":18, "fnd:GLOBALLY_UNIQUE":"true" }, "x-queryable":true }, "__FLEX_Context_DisplayValue":{ "title":"Context Segment", "type":"string", "description":"Context Segment", "nullable":true, "x-hints":{ "updateable":"false", "DISPLAYHINT":"Hide", "FND_ACFF_IsReadOnly":"true", "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_ListDisplayAttrName":"Name", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true }, "__FLEX_Context":{ "title":"Context Segment", "maxLength":30, "type":"string", "description":"Context Segment", "nullable":true, "x-hints":{ "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT", "controlType":"choice", "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue", "includeInCompactView":true, "FND_ACFF_IsDiscriminator":"true", "FND_ACFF_JavaType":"java.lang.String", "FND_ACFF_MaximumLength":"1024", "FND_ACFF_PreferredDisplayType":"LOV" }, "x-oj":{ "transform":{ "path":"oj-sp/common-util/flex-util", "name":"transformFlexUIHints" } }, "x-queryable":true } } }

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 : 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." } } }

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D10041%2CBind_DescriptiveFlexfieldCode%3DPJS_PROG_DESC_FLEX

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
• Display Attribute: Name, Description

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D10041%2CBind_DescriptiveFlexfieldCode%3DPJS_PROG_DESC_FLEX

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context; Target Attribute: ContextCode
• Display Attribute: Name

Back to Top

Examples

The following example shows how to create a program descriptive flexfield by submitting a POST request on the REST resource using cURL.

curl -H "Content-Type: application/json" --user ppm_cloud_user -X PATCH -d @example_request_payload.json https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPrograms/<projectProgramsUniqId>/child/ProgramDFF

Request Body Example

The following shows an example of the request body in JSON format.

{ "test": "some text" }

Response Body Example

The following shows an example of the response body in JSON format.

{ "ProjectProgramId": 300100575814383, "pincode": 123, "test": "some text", "__FLEX_Context": null, "__FLEX_Context_DisplayValue": null, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPrograms/300100575814383/child/ProgramDFF/300100575814383", "name": "ProgramDFF", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000978" } }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPrograms/300100575814383/child/ProgramDFF/300100575814383", "name": "ProgramDFF", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPrograms/300100575814383", "name": "projectPrograms", "kind": "item" } ] } 

Back to Top