1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Service Profiles

Get all service profiles

get

/crmRestApi/resources/11.13.18.05/serviceProfiles

Request

Query Parameters
  • 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 the service profile with the specified primary key.
      Finder Variables
      • ServiceProfileId; integer; The primary key of the service profile.
    • ServiceProfileAltKeyFinder Finds the service profile with the specified alternate key.
      Finder Variables
      • CustomerPartyNumber; string; The party number of the service profile customer.
      • PartySiteNumber; string; The site number of the service profile party site.
    • ServiceProfileByNumber Finds the service profile with the specified profile number.
      Finder Variables
      • ServiceProfileNumber; string; The profile number of the service profile.
  • 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:
    • ContactEmailAddress; string; The email address of the contact belonging to the service profile.
    • ContactPartyName; string; The name of the contact belonging to the service profile.
    • ContactPartyNumber; string; The PUID of the contact belonging to the service profile.
    • ContactPartyUniqueName; string; The unique name of the contact belonging to the service profile.
    • CreatedBy; string; The user that created the service profile contact.
    • CreationDate; string; The date when the service profile contact was created.
    • JobTitle; string; The job title of the contact belonging to the service profile.
    • LastUpdateDate; string; The date when the service profile contact was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the service profile contact.
    • LastUpdatedBy; string; The user who last updated the service profile contact.
    • PartyId; integer; The contact for the service profile contact.
    • ServiceProfileId; integer; The service profile for the service profile contact.
    • ServiceProfileName; string; The name of the service profile for the service profile contact.
    • ServiceProfileNumber; string; The PUID of the service profile for the service profile contact.
    • SpContactId; integer; The unique identifier of the service profile contact.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Binding; string; This is a hint for processing the Url Binding runtime.
    • SystemActionFlag; boolean; Boolean indicator.
    • URLBindingId; integer; Uniquely identifies the URL Bind for smart actions. For internal use.
    • URLBindingName; string; For action REST endpoints that require runtime binding, this is the key in the key value pair.
    • Value; string; For action REST endpoints that require runtime binding, this is the value in the key value pair.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BillToAccountSiteFormattedAddress; string; The formatted address to be billed for work performed for the service profile.
    • BillToCustomerAccountDescription; string; The description of the customer account to be billed for work performed for the service profile.
    • BillToCustomerAccountId; integer; The customer account to be billed for work performed for the service profile.
    • BillToCustomerAccountNumber; string; The PUID for the customer account to be billed for work performed for the service profile.
    • BillToCustomerAccountSiteId; integer; The customer account site to be billed for work performed for the service profile.
    • BillToCustomerId; integer; The customer to be billed for work performed for the service profile.
    • BillToCustomerPartyName; string; The name of the customer to be billed for work performed for the service profile.
    • BillToCustomerPartyNumber; string; The PUID for the customer to be billed for work performed for the service profile.
    • BillToCustomerPartyUniqueName; string; The unique name of the customer to be billed for work performed for the service profile.
    • BillToPartySiteId; integer; The party site to be billed for work performed for the service profile.
    • BillToPartySiteName; string; The name given to the party site that will be billed for work performed for the service profile.
    • BillToPartySiteNumber; string; The PUID for the party site that will be billed for work performed for the service profile.
    • BillingBUOrgId; integer; The business unit that maintains the billing address for the service profile.
    • CreatedBy; string; The user who created the service profile.
    • CreationDate; string; The date when the service profile was created.
    • CustomerPartyId; integer; The customer having the service profile.
    • CustomerPartyName; string; The name of the service profile customer.
    • CustomerPartyNumber; string; The PUID for the customer party of the service profile.
    • CustomerPartyType; string; Indicates whether the service profile customer is a person or organization.
    • CustomerPartyUniqueName; string; The unique name of the service profile customer.
    • LastUpdateDate; string; The date when the service profile was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the service profile.
    • LastUpdatedBy; string; The user who last updated the service profile.
    • PartySiteAddress1; string; The first address line for the service profile site address.
    • PartySiteAddress2; string; The second address line for the service profile site address.
    • PartySiteAddress3; string; The third address line for the service profile site address.
    • PartySiteAddress4; string; The fourth address line for the service profile site address.
    • PartySiteBuilding; string; The building information for the service profile site address.
    • PartySiteCity; string; The city for the service profile site address.
    • PartySiteCountry; string; The country for the service profile site address.
    • PartySiteCounty; string; The county for the service profile site address.
    • PartySiteFloorNumber; string; The floor in the building for the service profile site address.
    • PartySiteFormattedAddress; string; The formatted site address of the service profile.
    • PartySiteId; integer; The site address of the service profile.
    • PartySiteLatitude; number; The latitude coordinate for the service profile site address.
    • PartySiteLocationId; integer; The location identifier for the service profile site address.
    • PartySiteLongitude; number; The longitude coordinate for the service profile site address.
    • PartySiteName; string; The name given to the service profile site address.
    • PartySiteNumber; string; The PUID of the service profile site address.
    • PartySitePartyId; integer; The party of the service profile site address.
    • PartySitePartyName; string; The name of the party of the service profile site address.
    • PartySitePartyUniqueName; string; The unique name of the part of the service profile site address.
    • PartySitePostalCode; string; The postal code for the service profile site address.
    • PartySiteProvince; string; The province for the service profile site address.
    • PartySiteState; string; The state for the service profile site address.
    • PartySiteTimezoneCode; string; The time zone for the service profile site address.
    • PrimaryContactPartyId; integer; The primary contact of the service profile.
    • PrimaryContactPartyName; string; The name of the service profile primary contact.
    • PrimaryContactPartyNumber; string; The party number of the service profile primary contact.
    • ServiceProfileId; integer; The unique identifier of the service profile.
    • ServiceProfileName; string; The name of the service profile.
    • ServiceProfileNumber; string; The PUID of the service profile.
    • StatusCd; string; Indicates whether the service profile is active.
    • StripeCd; string; Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile.
    • TypeCd; string; The type of service profile.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ContactRelationshipId; integer; The relationship ID populated when the note is associated with a contact.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • CreatorPartyId; integer; The unique identifier of the party.
    • EmailAddress; string; The email address of the user who created the note.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The unique identifier of the note. This is the primary key of the notes table.
    • NoteId; integer; The unique identifier of the note. 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 column which stores the actual note text.
    • NoteTypeCode; string; The note type code for categorization of note.
    • ParentNoteId; integer; The unique identifier of the note. This is the primary key of the notes table.
    • PartyId; integer; The unique identifier of the party.
    • PartyName; string; The name of the party.
    • SourceObjectCode; string; This is the source object code for the source object as defined in OBJECTS Metadata.
    • SourceObjectId; string; The unique identifier of the parent source object associated to the note.
    • SourceSystem; string; This is the source object code for the source object as defined in OBJECTS Metadata.
    • VisibilityCode; string; The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Binding; string; Indicates the binding type of the value.
    • MandatoryFlag; boolean; Boolean value indicating if the payload is mandatory.
    • RequestPayloadId; integer; Uniquely identifies the payload for smart actions. For internal use.
    • RequestPayloadName; string; The key in the Key Value pair that forms the payload.
    • SmartSuggestPath; string; The path used for smart suggest.
    • SystemActionFlag; boolean; Boolean value.
    • Value; string; The value in the Key Value pair that forms the payload.
    • ValueStruct; string; If the value in the Key Value pair isn't a single value, this would be set.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ConfirmationMessage; string; A message to seek confirmation for the action being performed.
    • ContentType; string; The content type to use when invoking the REST endpoint.
    • DisplayLabel; string; Consumer-friendly action name.
    • Entity; string; REST Resources the action belongs to.
    • Href; string; The REST endpoint to perform the action.
    • IncludedInApplication; string; List of applications that this action can be used in.
    • MassActionFlag; boolean; Boolean type indicating if this action can be mass processed.
    • Method; string; HTTP method to use with HREF.
    • ObjectFunctionName; string; The object function associated with the smart action.
    • PageType; string; The list of pages that this action can be used in.
    • SmartSuggestFlag; boolean; Indicates if smart suggest is enabled for the action.
    • SystemActionFlag; boolean; Boolean type indicating if the action is seeded or custom.
    • UpdateOfAttributes; string; Attributes to be updated when the Actions UI is launched.
    • UserActionId; integer; Uniquely identifies the action. For internal use.
    • UserActionName; string; Uniquely identifies the action with a name. For internal use.
    • UserActionRank; integer; Number to indicate priority of the action.


    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • SystemActionFlag; boolean; Boolean value indicating if the action is seeded or custom.
    • UserActionNavAppUsage; string; Application usage.
    • UserActionNavBody; string; Metadata of the navigation as needed for the specific usage.
    • UserActionNavId; integer; Primary key for the user action navigation.
    • UserActionNavType; string; Provision for having multiple navigation flows for a given usage.
  • 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 : serviceProfiles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : serviceProfiles-item-response
Type: object
Show Source
Nested Schema : Service Profile Contacts
Type: array
Title: Service Profile Contacts
The service profile contacts resource is used to view, create, update, and delete a service profile contact. It's the list of the people that work with the assets grouped in the profile, including their preferences and restrictions for how they receive service. A given customer contact can be associated to one or more service profiles.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note objects resource is used to view the note objects.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : serviceProfiles-contacts-item-response
Type: object
Show Source
Nested Schema : serviceProfiles-notes-item-response
Type: object
Show Source
Nested Schema : serviceProfiles-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : serviceProfiles-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : serviceProfiles-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : serviceProfiles-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Examples

The following example shows how to get a smart text folder by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTextFolders/300100554656140' -X GET

Example of Response Body

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

{
    "CreatedBy": "automhrhdadm1",
    "CreationDate": "2022-02-16T18:20:09+00:00",
    "FolderId": 300100554656140,
    "LastUpdateDate": "2022-02-16T18:20:09.046+00:00",
    "LastUpdateLogin": "D78B83FBA684D806E0533DFDF40A3521",
    "LastUpdatedBy": "automhrhdadm1",
    "Name": "HRHDBUST",
    "ParentFolderId": null,
    "UserPartyId": null,
    "FolderNumber": null,
    "StripeCd": "ORA_SVC_HRHD",
    "Domain": "ORA_GENERIC",
    "FolderUniqueNumber": "CDRM_2",
    "BuOrgId": 300100545315608,
    "PartyNumber": null,
    "ParentFolderUniqueNumber": null,
    "ParentFolderName": null,
    "ParentBuOrgId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTextFolders/300100554656140",
            "name": "smartTextFolders",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTextFolders/300100554656140",
            "name": "smartTextFolders",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTextFolders/300100554656140/child/SmartTextChildFolders",
            "name": "SmartTextChildFolders",
            "kind": "collection"
        }
    ]
}
Back to Top