1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Program Enrollments
  4. Notes

Get all notes for an enrollment

get

/crmRestApi/resources/11.13.18.05/programEnrollments/{EnrollmentNumber}/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: Finds a note for the enrollment with the specified note ID.
      Finder Variables:
      • NoteId; integer; The unique Identifier of the note associated with the contact. This is the primary key of the notes table.
  • 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; The unique identifier of the relationship populated when the note is associated with a contact.
    • CreatedBy; string; The user who created the note record.
    • CreationDate; string; The date and time when the note record was created.
    • CreatorPartyId; integer; The unique party identifier for the note creator.
    • EmailAddress; string; The email address of the user who created the note.
    • LastUpdateDate; string; The date when the note data was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • NoteId; integer; The unique Identifier of the note associated with the contact. This is the primary key of the notes table.
    • NoteNumber; string; The alternate unique identifier of the note. A user key that's system generated or from an external system.
    • NoteTitle; string; The title of the note entered by the user.
    • NoteTxt; string; The actual note text.
    • NoteTypeCode; string; This code indicating the type of the note. A list of valid values is defined in the lookup ZMM_NOTE_TYPE.
    • ParentNoteId; integer; The unique identifier of the parent note.
    • PartyId; integer; 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.
    • PartyName; string; The name of a contact party.
    • SourceObjectCode; string; The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
    • SourceObjectId; string; The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on.
    • VisibilityCode; string; 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.
  • 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 : programEnrollments-Notes
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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 get all notes for an enrollment by submitting a get request on the REST resource using cURL.

cURL Command

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

Example of Response Body

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

{
-items:[5]
-0: {
NoteId: 300100059559515
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-06-30T22:50:43-07:00"
LastUpdateDate: "2015-06-30T22:50:43-07:00"
PartyId: 100010025532672
CorpCurrencyCode: "USD"
CurcyConvRateType: "Corporate"
CurrencyCode: "USD"
ContactRelationshipId: null
-links: [7]
-0: {
        ...
    }
-1: {
        ...
    }
-2: {
        ...
    }
...
}
-1: {
        ...
    }
...
}
Back to Top