Update a note

patch

/fscmRestApi/resources/11.13.18.05/packingUnits/{PackingUnitId}/child/nestedPackingUnits/{PackingUnitId2}/child/notes/{NoteId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource.
  • Title: Creator Party ID
    Value that uniquely identifies the creator of the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency conversion rate. This attribute is not currently used by the packingUnits resource.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    Text of the actual note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that identifies the categorization of the note type.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the packing unit.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that identifies the visibility level of the note.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : packingUnits-nestedPackingUnits-notes-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the relationship. This attribute is not currently used by the packingUnits resource.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the corporate currency. This attribute is not currently used by the packingUnits resource.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the note.
  • Title: Creation Date
    Read Only: true
    Date when the user created the note record.
  • Title: Creator Party ID
    Value that uniquely identifies the creator of the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency conversion rate. This attribute is not currently used by the packingUnits resource.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency. This attribute is not currently used by the packingUnits resource.
  • 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.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Title: Primary Address
    Read Only: true
    The address of the user who created the note.
  • Title: Primary Phone
    Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    Date when the user most recently updated the note data.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the note record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the note record.
  • Links
  • Title: Note ID
    Read Only: true
    Value that uniquely identifies the note.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    Text of the actual note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that identifies the categorization of the note type.
  • Title: Parent Note ID
    Value that uniquely identifies the parent note.
  • Title: Party ID
    Read Only: true
    Value that uniquely identifies the party to which the note is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    Name of the user who created the record.
  • 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.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the packing unit.
  • 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.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that identifies the visibility level of the note.
Back to Top