Create one note
post
/fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}/child/notes
Request
Path Parameters
-
PackingUnitId(required): integer(int64)
Value that uniquely identifies the packing unit.
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
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Value that uniquely identifies the creator of the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency conversion rate. This attribute is not currently used by the packingUnits resource. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Text of the actual note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Abbreviation that identifies the categorization of the note type. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Value that uniquely identifies the parent note. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Abbreviation that identifies the object as defined in the OBJECTS metadata which is associated with the note. The object identifier is SHIPPING_LPN for packing units. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Value that uniquely identifies the packing unit. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Abbreviation that identifies the visibility level of the note.
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.
Root Schema : packingUnits-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the note. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the note record. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Value that uniquely identifies the creator of the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency conversion rate. This attribute is not currently used by the packingUnits resource. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the note can be deleted. If false, then the note can be deleted. The default value is true. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the note data. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the note record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login of the user who most recently updated the note record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Value that uniquely identifies the note. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Text of the actual note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Abbreviation that identifies the categorization of the note type. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Value that uniquely identifies the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Value that uniquely identifies the party to which the note is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
Name of the user who created the record. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Abbreviation that identifies the object as defined in the OBJECTS metadata which is associated with the note. The object identifier is SHIPPING_LPN for packing units. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Value that uniquely identifies the packing unit. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the note can be updated. If false, then the note cannot be updated. The default value is true. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Abbreviation that identifies the visibility level of 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.
Links
- NoteSourceTypeVA
-
Operation: /crmRestApi/resources/11.13.18.05/noteTypesParameters:
- finder:
NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}
The following properties are defined on the LOV link relation:- Source Attribute: NoteTypeCode; Target Attribute: MappedLookupCode
- Display Attribute: Meaning
- finder:
- NoteVisibilityLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
The following properties are defined on the LOV link relation:- Source Attribute: VisibilityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrenciesVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
Examples
This example describes how to create one note.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/packingUnits/PackingUnitId/child/notes"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "NoteTxt" : "UE9TVCBPUEVSQVRJT04gRlJPTSBQQUNLSU5HIFVOSVQgUkVTVCBTRVJWSUNF", "NoteTypeCode" : "LPN_PACKING_INSTRUCTIONS", "VisibilityCode" : "EXTERNAL" }