Create a program note
post
/fscmRestApi/resources/11.13.18.05/projectPrograms/{projectProgramsUniqID}/child/ProgramNotes
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:
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
-
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Unique identifier of the user who created the note. -
NoteNumber: string
Title:
Note Number
Maximum Length:30
The unique number of the program note. The default value is a system-generated number. -
NoteTxt: string
(byte)
Title:
Note Text
The text for the program note.
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 : projectPrograms-ProgramNotes-item-response
Type:
Show Source
object
-
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. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Unique identifier of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update 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. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the program note. -
NoteNumber: string
Title:
Note Number
Maximum Length:30
The unique number of the program note. The default value is a system-generated number. -
NoteTxt: string
(byte)
Title:
Note Text
The text for the program note. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the user who created the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Examples
The following example shows how to create a program note.
curl --user ppm_cloud_user -X POST -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectPrograms/<projectProgramId>/child/ProgramNotes"
Request Body Example
The following shows an example of the request body in JSON format.
{ "NoteTxt":"TXkgdGVzdCBub3Rl" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "NoteId": 300100549427025, "NoteNumber": "CDRM_66318", "CreatedBy": "Clayton.Smith", "CreationDate": "2022-03-01T08:16:53+00:00", "LastUpdateDate": "2022-03-01T08:16:53.143+00:00", "LastUpdatedBy": "Clayton.Smith", "links": [ { "rel": "self", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355145/child/ProgramNotes/300100549427025", "name": "ProgramNotes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355145/child/ProgramNotes/300100549427025", "name": "ProgramNotes", "kind": "item" }, { "rel": "parent", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355145", "name": "projectPrograms", "kind": "item" }, { "rel": "enclosure", "href": "https://fuscdrmsmc34-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/projectPrograms/300100549355145/child/ProgramNotes/300100549427025/enclosure/NoteTxt", "name": "NoteTxt", "kind": "other" } ] }