Get all asset notes

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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: Find asset notes according to the asset note identifier.
      Finder Variables:
      • NoteId; integer; Value that uniquely identifies the asset note.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 customer contact who created the note. This attribute is read-only. This attribute is not currently used.
    • CreatedBy; string; User who created the note for the asset. The application automatically sets this value during creation.This attribute is read-only.
    • CreationDate; string; Date when the note is created. The application automatically sets this value during creation.This attribute is read-only.
    • CreatorPartyId; integer; Value that uniquely identifies the user who created the note. The application automatically sets this value during creation. This attribute is read-only.
    • EmailAddress; string; 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.
    • LastUpdateDate; string; Date when the user most recently updated the note. The application automatically sets this value during creation.This attribute is read-only.
    • LastUpdateLogin; string; 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.
    • LastUpdatedBy; string; 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.
    • NoteId; integer; Value that uniquely identifies the note for the asset. The application sets this value during note creation. This attribute is read-only.
    • NoteNumber; string; Number that identifies the application used to generate the note. This attribute is automatically defaulted during creation. This attribute is read-only.
    • NoteTitle; string; Title of the note. This attribute is optional, which can be entered by the user.
    • NoteTxt; string; Actual text of the note.
    • NoteTypeCode; string; Abbreviation that uniquely identifies the type of note. The application automatically sets this value during creation. This attribute is read-only.
    • ParentNoteId; integer; Value that uniquely identifies the parent note. The application assigns a value to this attribute during creation. This attribute is read-only.
    • PartyId; integer; Value that uniquely identifies the user who created the note. The application automatically sets this value during creation.This attribute is read-only.
    • PartyName; string; Name of the user who created the note for the asset. The application automatically sets this value during creation. This attribute is read-only.
    • SourceObjectCode; string; 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.
    • SourceObjectId; string; 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.
    • VisibilityCode; string; 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.
  • 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
  • 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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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