Create a asset note

post

/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/notes

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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the customer contact who created the note. This attribute is read-only. This attribute is not currently used.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used.
  • Title: Creator Party ID
    Value that uniquely identifies the user who created the note. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency of the party who created the note. This attribute is read-only. This attribute is not currently used.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used.
  • Maximum Length: 30
    Number that identifies the application used to generate the note. This attribute is automatically defaulted during creation. This attribute is read-only.
  • Title: Title
    Maximum Length: 500
    Title of the note. This attribute is optional, which can be entered by the user.
  • Title: Note
    Actual text of the note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that uniquely identifies the type of note. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Parent Note ID
    Value that uniquely identifies the parent note. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Title: Related Object Type
    Maximum Length: 30
    Name of the source object that created the note. The application automatically sets this value to CSE_ASSET during creation. This attribute is read-only.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the source object for the note. The application automatically sets this value to Asset identifier during creation. This attribute is read-only.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that uniquely identifies the visibility to other users of the note. Valid values include INTERNAL, EXTERNAL and PRIVATE. If set to PRIVATE, then only the user who created the note can view, edit, or delete the note. This attribute is read-only.
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 : installedBaseAssets-notes-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    Value that uniquely identifies the customer contact who created the note. This attribute is read-only. This attribute is not currently used.
  • Title: Corporate Currency Code
    Maximum Length: 15
    Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the note for the asset. The application automatically sets this value during creation.This attribute is read-only.
  • Title: Creation Date
    Read Only: true
    Date when the note is created. The application automatically sets this value during creation.This attribute is read-only.
  • Title: Creator Party ID
    Value that uniquely identifies the user who created the note. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    Type of currency of the party who created the note. This attribute is read-only. This attribute is not currently used.
  • Title: Currency
    Maximum Length: 15
    Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used.
  • Title: Delete Indicator
    Read Only: true
    Contains one of the following values: true or false. If true, then the user has access to delete the record. If false, then the user does not have access to delete the record. This attribute value is set during the creation of the note and the value is derived based on whether the user has permission to delete the note or not. This attribute is read-only.
  • Title: Primary Email
    Read Only: true
    Maximum Length: 320
    Email address of the user who created the note for the asset. The application automatically sets this value to the e-mail address of the logged in user during creation. This attribute is read-only.
  • Title: Primary Address
    Read Only: true
    Address of the user who created the note for the asset. The application automatically sets this value to the formatted address of the logged in user during creation. This attribute is read-only.
  • Title: Primary Phone
    Read Only: true
    Phone number of the user who created the note for the asset. The application automatically sets this value to the formatted phone number of the logged in user during creation. This attribute is read-only.
  • Title: Last Update Date
    Read Only: true
    Date when the user most recently updated the note. The application automatically sets this value during creation.This attribute is read-only.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the note for the asset. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    Login that the user used when updating the note for the asset. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
  • Title: Note ID
    Read Only: true
    Value that uniquely identifies the note for the asset. The application sets this value during note creation. This attribute is read-only.
  • Maximum Length: 30
    Number that identifies the application used to generate the note. This attribute is automatically defaulted during creation. This attribute is read-only.
  • Title: Title
    Maximum Length: 500
    Title of the note. This attribute is optional, which can be entered by the user.
  • Title: Note
    Actual text of the note.
  • Title: Type
    Maximum Length: 30
    Abbreviation that uniquely identifies the type of note. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Parent Note ID
    Value that uniquely identifies the parent note. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Title: Party ID
    Read Only: true
    Value that uniquely identifies the user who created the note. The application automatically sets this value during creation.This attribute is read-only.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    Name of the user who created the note for the asset. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Related Object Type
    Maximum Length: 30
    Name of the source object that created the note. The application automatically sets this value to CSE_ASSET during creation. This attribute is read-only.
  • Title: Related Object
    Maximum Length: 64
    Value that uniquely identifies the source object for the note. The application automatically sets this value to Asset identifier during creation. This attribute is read-only.
  • Title: Update Indicator
    Read Only: true
    Contains one of the following values: true or false. If true, then user has access to update the record. If false, then user does not have access to update the record. This attribute value is set during the creation of the note and the value is derived based on whether the user has permission to update the note or not. This attribute is read-only.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Abbreviation that uniquely identifies the visibility to other users of the note. Valid values include INTERNAL, EXTERNAL and PRIVATE. If set to PRIVATE, then only the user who created the note can view, edit, or delete the note. This attribute is read-only.
Back to Top