Jump to

• Request
• Response

Get one asset note

get

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

Request

Path Parameters

• AssetId(required): integer(int64)
  Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.
• NoteId(required): integer(int64)
  Value that uniquely identifies the note for the asset. The application sets this value during note creation. This attribute is read-only.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : installedBaseAssets-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  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.
• CorpCurrencyCode: string
  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.
• CreatedBy: string
  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.
• CreationDate: string (date-time)
  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.
• CreatorPartyId: integer (int64)
  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.
• CurcyConvRateType: string
  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.
• CurrencyCode: string
  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.
• DeleteFlag: boolean
  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.
• EmailAddress: string
  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.
• FormattedAddress: string
  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.
• FormattedPhoneNumber: string
  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.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdateLogin: string
  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: 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 for the asset. The application sets this value during note creation. This attribute is read-only.
• NoteNumber: string
  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.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  Title of the note. This attribute is optional, which can be entered by the user.
• NoteTxt: string (byte)
  Title: Note

  Actual text of the note.
• NoteTypeCode: string
  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.
• ParentNoteId: integer (int64)
  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.
• PartyId: integer (int64)
  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.
• PartyName: string
  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.
• SourceObjectCode: string
  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.
• SourceObjectId: string
  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.
• UpdateFlag: boolean
  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.
• VisibilityCode: string
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the note is created. The application automatically sets this value during creation.This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the user who created the note for the asset. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of currency of the party who created the note. This attribute is read-only. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer contact who created the note. This attribute is read-only. This attribute is not currently used.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the application used to generate the note. This attribute is automatically defaulted during creation. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Actual text of the note.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"Title of the note. This attribute is optional, which can be entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"Value that uniquely identifies the note for the asset. The application sets this value during note creation. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the note for the asset. The application automatically sets this value during creation.This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the user who created the note. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the type of note. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the user who created the note. The application automatically sets this value during creation.This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Value that uniquely identifies the parent note. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated the note. The application automatically sets this value during creation.This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

NoteSourceTypeVA

Operation: /crmRestApi/resources/11.13.18.05/noteTypes

Parameters:

• finder: NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}

The following properties are defined on the LOV link relation:

• Source Attribute: NoteTypeCode; Target Attribute: MappedLookupCode
• Display Attribute: Meaning

NoteVisibilityLookupVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

RatedCurrenciesVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode

Back to Top