Create a note for an enrollment

post

/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/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
    The unique identifier of the relationship populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the note associated with the contact. 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.
  • Title: Creator Party ID
    The unique party identifier for the note creator.
  • 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.
  • 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.
  • 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
    The actual note text.
  • Title: Type
    Maximum Length: 30
    This code indicating the type of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Title: Related Object Type
    Maximum Length: 30
    The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
  • Title: Related Object
    Maximum Length: 64
    The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal, external or private. A list of valid values is defined in the lookup ZMM_NOTE_VISIBILITY.
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 : programEnrollments-Notes-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the note associated with the contact. 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the note record.
  • Title: Creation Date
    Read Only: true
    The date and time when the note record was created.
  • Title: Creator Party ID
    The unique party identifier for the note creator.
  • 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.
  • 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.
  • 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.
  • 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
    The date when the note data was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique Identifier of the note associated with the contact. This is the primary key of the notes table.
  • 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
    The actual note text.
  • Title: Type
    Maximum Length: 30
    This code indicating the type of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Title: Party ID
    Read Only: true
    The unique Identifier of the contact to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of a contact party.
  • Title: Related Object Type
    Maximum Length: 30
    The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
  • Title: Related Object
    Maximum Length: 64
    The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
  • 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.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal, external or private. A list of valid values is defined in the lookup ZMM_NOTE_VISIBILITY.
Back to Top

Examples

The following example shows how to create a note for an enrollment by submitting a post request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/programEnrollments/ ENRM_12345/child/Notes

Example of Request Body

The following shows an example of the request body in JSON format.

{
"Notes":
  [
{     
 "NoteTxt": "This is the note text.",
"VisibilityCode": "INTERNAL",
"CurrencyCode": "USD",
"CurcyConvRateType": "Corporate",
"NoteTypeCode": "GENERAL",
"CorpCurrencyCode": "USD",
"CreatorPartyId": 100010025532672
   }
  ]
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
NoteId: 300100059559803
SourceObjectCode: "PROGRAMENROLLMENTS"
SourceObjectId: "300100000408620"
PartyName: "Gabrielle Lee"
NoteTypeCode: "GENERAL"
VisibilityCode: "INTERNAL"
CreatorPartyId: 100010025532672
NoteAttributeCategory: null
NoteAttributeUid1: null
NoteAttributeUid2: null
NoteAttributeUid3: null
NoteAttributeUid4: null
NoteAttributeUid5: null
CreatedBy: "CHANNEL_OPERATIONS_MANAGER"
CreationDate: "2015-07-02T01:58:19-07:00"
LastUpdateDate: "2015-07-02T01:58:19-07:00"
PartyId: 100010025532672
CorpCurrencyCode: "USD"
CurcyConvRateType: "Corporate"
CurrencyCode: "USD"
ContactRelationshipId: null
-links: [7]
-0: {
                 ...
    }
-1: {
                 ...
    }
-2: {
                 ...
    }
...
}

Back to Top