Get all notes
get
/fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}/child/notes
Request
Path Parameters
-
PackingUnitId(required): integer(int64)
Value that uniquely identifies the packing unit.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds notes according to the primary key.
Finder Variables:- NoteId; integer; Value that uniquely identifies the note.
- PrimaryKey: Finds notes according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ContactRelationshipId; integer; Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource.
- CreatedBy; string; User who created the note.
- CreationDate; string; Date when the user created the note record.
- CreatorPartyId; integer; Value that uniquely identifies the creator of the note.
- EmailAddress; string; The email address of the user who created the note.
- LastUpdateDate; string; Date when the user most recently updated the note data.
- LastUpdateLogin; string; Login of the user who most recently updated the note record.
- LastUpdatedBy; string; User who most recently updated the note record.
- NoteId; integer; Value that uniquely identifies the note.
- NoteNumber; string; The alternate unique identifier of the note. A user key that's system generated or from an external system.
- NoteTitle; string; The title of the note entered by the user.
- NoteTxt; string; Text of the actual note.
- NoteTypeCode; string; Abbreviation that identifies the categorization of the note type.
- ParentNoteId; integer; Value that uniquely identifies the parent note.
- PartyId; integer; Value that uniquely identifies the party to which the note is associated.
- PartyName; string; Name of the user who created the record.
- SourceObjectCode; string; 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; Value that uniquely identifies the packing unit.
- VisibilityCode; string; Abbreviation that identifies the visibility level of the note.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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 : packingUnits-notes
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.
Examples
This example describes how to get all notes.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/packingUnits/PackingUnitId/child/notes"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "NoteId": 300100124601004, "SourceObjectCode": "SHIPPING_LPN", "SourceObjectId": "5062", "PartyName": "John Smith", "NoteTypeCode": "LPN_PACKING_INSTRUCTIONS", "VisibilityCode": "EXTERNAL", "CreatorPartyId": 100010025531652, "CreatedBy": "WHSE_MGR_V1", "CreationDate": "2018-03-13T04:12:19-07:00", "LastUpdateDate": "2018-03-13T04:12:20.434-07:00", "PartyId": 100010025531652, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "CurrencyCode": "USD", "ContactRelationshipId": null, "ParentNoteId": null, "LastUpdatedBy": "WHSE_MGR_V1", "LastUpdateLogin": "6748B9B587BB75BAE0530803F00A8333", "EmailAddress": "john.smith@example.com", "FormattedAddress": "Road Number 1,SACRAMENTO, 95841", "FormattedPhoneNumber": "+1 (111) 111-1111", "UpdateFlag": "true", "DeleteFlag": "true", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601004", "name": "notes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601004", "name": "notes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062", "name": "packingUnits", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601004/lov/NoteVisibilityLookupVA", "name": "NoteVisibilityLookupVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601004/lov/RatedCurrenciesVA", "name": "RatedCurrenciesVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601004/lov/NoteSourceTypeVA", "name": "NoteSourceTypeVA", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601004/enclosure/NoteTxt", "name": "NoteTxt", "kind": "other" } ] }, { "NoteId": 300100124601002, "SourceObjectCode": "SHIPPING_LPN", "SourceObjectId": "5062", "PartyName": "John Smith", "NoteTypeCode": "LPN_PACKING_INSTRUCTIONS", "VisibilityCode": "EXTERNAL", "CreatorPartyId": 100010025531652, "CreatedBy": "WHSE_MGR_V1", "CreationDate": "2018-03-13T04:10:46-07:00", "LastUpdateDate": "2018-03-13T04:10:49.512-07:00", "PartyId": 100010025531652, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "CurrencyCode": "USD", "ContactRelationshipId": null, "ParentNoteId": null, "LastUpdatedBy": "WHSE_MGR_V1", "LastUpdateLogin": "6748B9B587BB75BAE0530803F00A8333", "EmailAddress": "john.smith@example.com", "FormattedAddress": "Road Number 1,SACRAMENTO, 95841", "FormattedPhoneNumber": "+1 (111) 111-1111", "UpdateFlag": "true", "DeleteFlag": "true", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601002", "name": "notes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601002", "name": "notes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062", "name": "packingUnits", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601002/lov/NoteVisibilityLookupVA", "name": "NoteVisibilityLookupVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601002/lov/RatedCurrenciesVA", "name": "RatedCurrenciesVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601002/lov/NoteSourceTypeVA", "name": "NoteSourceTypeVA", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124601002/enclosure/NoteTxt", "name": "NoteTxt", "kind": "other" } ] }, { "NoteId": 300100124589000, "SourceObjectCode": "SHIPPING_LPN", "SourceObjectId": "5062", "PartyName": "John Smith", "NoteTypeCode": "LPN_PACKING_INSTRUCTIONS", "VisibilityCode": "EXTERNAL", "CreatorPartyId": 100010025531652, "CreatedBy": "WHSE_MGR_V1", "CreationDate": "2018-03-12T04:59:18-07:00", "LastUpdateDate": "2018-03-12T04:59:21.653-07:00", "PartyId": 100010025531652, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "CurrencyCode": "USD", "ContactRelationshipId": null, "ParentNoteId": null, "LastUpdatedBy": "WHSE_MGR_V1", "LastUpdateLogin": "67344FC4AAD801ABE0530803F00A5C2C", "EmailAddress": "john.smith@example.com", "FormattedAddress": "Road Number 1,SACRAMENTO, 95841", "FormattedPhoneNumber": "+1 (111) 111-1111", "UpdateFlag": "true", "DeleteFlag": "true", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124589000", "name": "notes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124589000", "name": "notes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062", "name": "packingUnits", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124589000/lov/NoteVisibilityLookupVA", "name": "NoteVisibilityLookupVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124589000/lov/RatedCurrenciesVA", "name": "RatedCurrenciesVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124589000/lov/NoteSourceTypeVA", "name": "NoteSourceTypeVA", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes/300100124589000/enclosure/NoteTxt", "name": "NoteTxt", "kind": "other" } ] } ], "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/packingUnits/5062/child/notes", "name": "notes", "kind": "collection" } ] }