Update a note
patch
/crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/Note/{NoteId}
Request
Path Parameters
-
ClaimCode(required): string
The user-defined, unique label for the MDF claim.
-
NoteId(required): integer(int64)
The unique identifier of the note associated with the MDF claim. This is the primary key of the notes table.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the contact relationship. This attribute is populated when the note is associated with an MDF claim user. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the MDF claim. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party that the note creator belongs to. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
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.
Root Schema : mdfClaims-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the contact relationship. This attribute is populated when the note is associated with an MDF claim user. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the MDF claim. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party that the note creator belongs to. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N. -
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
The date and time when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the note. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the note. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the note associated with the MDF claim. This is the primary key of the notes table. -
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
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party associated with the note. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of an MDF claim party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan, and so on. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
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.
Links
- NoteSourceTypeVA
-
Operation: /crmRestApi/resources/11.13.18.05/noteTypesParameters:
- finder:
NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}
The list of values indicating the type of note associated with the MDF claim, such as General, Reference, or Special.
The following properties are defined on the LOV link relation:- Source Attribute: NoteTypeCode; Target Attribute: MappedLookupCode
- Display Attribute: Meaning
- finder:
- NoteVisibilityLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
The list of values indicating the level of visibility of the note, such as internal or external.
The following properties are defined on the LOV link relation:- Source Attribute: VisibilityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrenciesVA
-
The list of values indicating the currency code associated with the note, such as USD, CAD, or Euro.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode