Get a service profile
get
/crmRestApi/resources/11.13.18.05/serviceProfiles/{serviceProfiles_Id}
Request
Path Parameters
-
serviceProfiles_Id(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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: string
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: string
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 TopResponse
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 : serviceProfiles-item-response
Type:
Show Source
object-
BillingBUOrgId: integer
(int64)
Title:
Billing Business Unit IDThe business unit that maintains the billing address for the service profile. -
BillingBusinessUnitName: string
Title:
Billing Business Unit NameRead Only:trueMaximum Length:240The name of the business unit that maintains the billing address for the service profile. -
BillToAccountSiteFormattedAddress: string
Title:
Bill-to Account Site Formatted AddressRead Only:trueMaximum Length:1000The formatted address to be billed for work performed for the service profile. -
BillToCustomerAccountDescription: string
Title:
Bill-to Customer Account DescriptionRead Only:trueMaximum Length:240The description of the customer account to be billed for work performed for the service profile. -
BillToCustomerAccountId: integer
(int64)
Title:
Bill-to Customer Account IDThe customer account to be billed for work performed for the service profile. -
BillToCustomerAccountNumber: string
Title:
Bill-to Customer Account NumberMaximum Length:30The PUID for the customer account to be billed for work performed for the service profile. -
BillToCustomerAccountSiteId: integer
(int64)
Title:
Bill-to Customer Account Site IDThe customer account site to be billed for work performed for the service profile. -
BillToCustomerId: integer
(int64)
Title:
Bill-to Customer IDThe customer to be billed for work performed for the service profile. -
BillToCustomerPartyName: string
Title:
Bill-to Customer Party NameRead Only:trueMaximum Length:360The name of the customer to be billed for work performed for the service profile. -
BillToCustomerPartyNumber: string
Title:
Bill-to Customer Registry NumberRead Only:trueMaximum Length:30The PUID for the customer to be billed for work performed for the service profile. -
BillToCustomerPartyUniqueName: string
Title:
Bill-to Customer Party Unique NameRead Only:trueMaximum Length:900The unique name of the customer to be billed for work performed for the service profile. -
BillToPartySiteId: integer
(int64)
Title:
Bill-To Party Site IDThe party site to be billed for work performed for the service profile. -
BillToPartySiteName: string
Title:
Bill-to Party Site NameRead Only:trueMaximum Length:240The name given to the party site that will be billed for work performed for the service profile. -
BillToPartySiteNumber: string
Title:
Bill-to Party Site NumberRead Only:trueMaximum Length:30The PUID for the party site that will be billed for work performed for the service profile. -
contacts: array
Service Profile Contacts
Title:
Service Profile ContactsThe 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. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the service profile. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the service profile was created. -
CustomerPartyId: integer
(int64)
Title:
Customer Party IDThe customer having the service profile. -
CustomerPartyName: string
Title:
Customer NameRead Only:trueMaximum Length:360The name of the service profile customer. -
CustomerPartyNumber: string
Title:
Customer Registry NumberRead Only:trueMaximum Length:30The PUID for the customer party of the service profile. -
CustomerPartyType: string
Title:
Customer Party TypeMaximum Length:30Indicates whether the service profile customer is a person or organization. -
CustomerPartyUniqueName: string
Title:
Customer Unique NameRead Only:trueMaximum Length:900The unique name of the service profile customer. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the service profile was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the service profile. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the service profile. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
notes: array
Notes
Title:
NotesThe note objects resource is used to view the note objects. -
PartySiteAddress1: string
Title:
Address1Read Only:trueMaximum Length:240The first address line for the service profile site address. -
PartySiteAddress2: string
Title:
Address2Read Only:trueMaximum Length:240The second address line for the service profile site address. -
PartySiteAddress3: string
Title:
Address3Read Only:trueMaximum Length:240The third address line for the service profile site address. -
PartySiteAddress4: string
Title:
Address4Read Only:trueMaximum Length:240The fourth address line for the service profile site address. -
PartySiteBuilding: string
Title:
BuildingRead Only:trueMaximum Length:240The building information for the service profile site address. -
PartySiteCity: string
Title:
CityRead Only:trueMaximum Length:60The city for the service profile site address. -
PartySiteCountry: string
Title:
CountryRead Only:trueMaximum Length:2The country for the service profile site address. -
PartySiteCounty: string
Title:
CountyRead Only:trueMaximum Length:60The county for the service profile site address. -
PartySiteFloorNumber: string
Title:
Floor NumberRead Only:trueMaximum Length:40The floor in the building for the service profile site address. -
PartySiteFormattedAddress: string
Title:
Party Site Formatted AddressRead Only:trueMaximum Length:1000The formatted site address of the service profile. -
PartySiteId: integer
(int64)
Title:
Party Site IDThe site address of the service profile. -
PartySiteLatitude: number
Title:
LatitudeRead Only:trueThe latitude coordinate for the service profile site address. -
PartySiteLocationId: integer
(int64)
Title:
Site Location IDRead Only:trueThe location identifier for the service profile site address. -
PartySiteLongitude: number
Title:
LongitudeRead Only:trueThe longitude coordinate for the service profile site address. -
PartySiteName: string
Title:
Site NameRead Only:trueMaximum Length:240The name given to the service profile site address. -
PartySiteNumber: string
Title:
Site NumberRead Only:trueMaximum Length:30The PUID of the service profile site address. -
PartySitePartyId: integer
(int64)
Title:
Site Party IDRead Only:trueThe party of the service profile site address. -
PartySitePartyName: string
Title:
Site Party NameRead Only:trueMaximum Length:360The name of the party of the service profile site address. -
PartySitePartyUniqueName: string
Title:
Site Party Unique NameRead Only:trueMaximum Length:900The unique name of the part of the service profile site address. -
PartySitePostalCode: string
Title:
Postal CodeRead Only:trueMaximum Length:60The postal code for the service profile site address. -
PartySiteProvince: string
Title:
ProvinceRead Only:trueMaximum Length:60The province for the service profile site address. -
PartySiteState: string
Title:
StateRead Only:trueMaximum Length:60The state for the service profile site address. -
PartySiteTimezoneCode: string
Title:
Time Zone CodeRead Only:trueMaximum Length:64The time zone for the service profile site address. -
PartySiteUse: string
Title:
Address TypeRead Only:trueMaximum Length:750The type of address stored for the service profile site address. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party IDThe primary contact of the service profile. -
PrimaryContactPartyName: string
Title:
Primary Contact NameRead Only:trueMaximum Length:360The name of the service profile primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party NumberRead Only:trueMaximum Length:30The party number of the service profile primary contact. -
ServiceProfileId: integer
(int64)
Title:
Service Profile IDRead Only:trueThe unique identifier of the service profile. -
ServiceProfileName: string
Title:
Service Profile NameMaximum Length:400The name of the service profile. -
ServiceProfileNumber: string
Title:
Service Profile NumberMaximum Length:30The PUID of the service profile. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
StatusCd: string
Title:
Status CodeMaximum Length:30Default Value:ORA_SVC_ACTIVEIndicates whether the service profile is active. -
StripeCd: string
Title:
Stripe CodeMaximum Length:30Default Value:ORA_SVC_CRMIndicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile. -
TypeCd: string
Title:
Type CDMaximum Length:30Default Value:ORA_SVC_SITEThe type of service profile.
Nested Schema : Service Profile Contacts
Type:
arrayTitle:
Service Profile ContactsThe 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 : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
arrayTitle:
NotesThe note objects resource is used to view the note objects.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : serviceProfiles-contacts-item-response
Type:
Show Source
object-
ContactEmailAddress: string
Title:
Contact Email AddressRead Only:trueMaximum Length:320The email address of the contact belonging to the service profile. -
ContactFormattedPhoneNumber: string
Title:
Phone NumberRead Only:trueThe phone number of the contact belonging to the service profile. -
ContactPartyName: string
Title:
Contact NameRead Only:trueMaximum Length:360The name of the contact belonging to the service profile. -
ContactPartyNumber: string
Title:
Contact NumberRead Only:trueMaximum Length:30The PUID of the contact belonging to the service profile. -
ContactPartyUniqueName: string
Title:
Contact Unique NameRead Only:trueMaximum Length:900The unique name of the contact belonging to the service profile. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user that created the service profile contact. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the service profile contact was created. -
JobTitle: string
Title:
Job TitleRead Only:trueMaximum Length:100The job title of the contact belonging to the service profile. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the service profile contact was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the service profile contact. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the service profile contact. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party IDThe contact for the service profile contact. -
PrimaryContactFlag: boolean
Title:
PrimaryIndicates the contact is the primary contact for the service profile. -
ServiceProfileId: integer
(int64)
Title:
Service Profile IDThe service profile for the service profile contact. -
ServiceProfileName: string
Title:
Service Profile NameRead Only:trueMaximum Length:400The name of the service profile for the service profile contact. -
ServiceProfileNumber: string
Title:
Service Profile NumberMaximum Length:30The PUID of the service profile for the service profile contact. -
SpContactId: integer
(int64)
Title:
Service Profile Contact IDRead Only:trueThe unique identifier of the service profile contact.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : serviceProfiles-notes-item-response
Type:
Show Source
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
CurrencyMaximum Length:15The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the note. -
EmailAddress: string
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
TitleMaximum Length:500The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
NoteThe column which stores the actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of the party. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The unique identifier of the parent source object associated to the note. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user can update the note. -
VisibilityCode: string
Title:
PrivateMaximum Length:30Default Value:INTERNALThe attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : serviceProfiles-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf 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:
arrayTitle:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Show Source
Nested Schema : serviceProfiles-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : serviceProfiles-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- CustomerPartyTypeLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CUSTOMER_PARTY_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: CustomerPartyType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StatusCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SPROF_STATUS_CD
The following properties are defined on the LOV link relation:- Source Attribute: StatusCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- StripeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: StripeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- TypeCdLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_SPROF_TYPE_CD
The following properties are defined on the LOV link relation:- Source Attribute: TypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- contacts
-
Parameters:
- serviceProfiles_Id:
$request.path.serviceProfiles_Id
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. - serviceProfiles_Id:
- notes
-
Parameters:
- serviceProfiles_Id:
$request.path.serviceProfiles_Id
The note objects resource is used to view the note objects. - serviceProfiles_Id:
- smartActions
-
Operation: /crmRestApi/resources/11.13.18.05/serviceProfiles/{serviceProfiles_Id}/child/smartActionsParameters:
- serviceProfiles_Id:
$request.path.serviceProfiles_Id
This VO stores the endpoint and security details for every user action. - serviceProfiles_Id:
Examples
The following example shows how to get a service profile 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/serviceProfiles/CDRM_861007'
-X GET
Example of Response Body
The following shows an example of the response body in JSON format.
{
"ServiceProfileId": 100105690702312,
"ServiceProfileNumber": "CDRM_861007",
"ServiceProfileName": "CXContactWO1_Site1",
"CreationDate": "2024-06-30T14:24:20.673+00:00",
"CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
"LastUpdateDate": "2024-06-30T14:27:49+00:00",
"LastUpdatedBy": "FUSION",
"LastUpdateLogin": "1BD74F24EF34286EE0636F6315ACE237",
"TypeCd": "ORA_SVC_SITE",
"StatusCd": "ORA_SVC_ACTIVE",
"PartySiteId": 300100608545635,
"PartySiteNumber": "CDRM_861007",
"PartySiteName": null,
"PartySitePartyId": 300100608545627,
"PartySitePartyName": "CXContactWO1 SVC",
"PartySitePartyUniqueName": "CXContactWO1 SVC (DENVER, US)",
"PartySiteLocationId": 300100608545634,
"PartySiteFormattedAddress": "Address1,Address2,DENVER, IN",
"PartySiteAddress1": "Address1",
"PartySiteAddress2": "Address2",
"PartySiteAddress3": null,
"PartySiteAddress4": null,
"PartySiteCity": "DENVER",
"PartySiteState": "IN",
"PartySiteProvince": null,
"PartySiteCounty": null,
"PartySitePostalCode": null,
"PartySiteCountry": "US",
"PartySiteBuilding": null,
"PartySiteFloorNumber": null,
"PartySiteTimezoneCode": null,
"PartySiteLongitude": null,
"PartySiteLatitude": null,
"PartySiteUse": null,
"CustomerPartyId": 300100608545627,
"CustomerPartyNumber": "CDRM_958918",
"CustomerPartyName": "CXContactWO1 SVC",
"CustomerPartyUniqueName": "CXContactWO1 SVC (DENVER, US)",
"CustomerPartyType": "PERSON",
"BillToCustomerId": null,
"BillToCustomerPartyNumber": null,
"BillToCustomerPartyName": null,
"BillToCustomerPartyUniqueName": null,
"BillToCustomerAccountId": null,
"BillToCustomerAccountNumber": null,
"BillToCustomerAccountDescription": null,
"BillToCustomerAccountSiteId": null,
"BillToAccountSiteFormattedAddress": null,
"BillToPartySiteId": null,
"BillToPartySiteNumber": null,
"BillToPartySiteName": null,
"PrimaryContactPartyId": null,
"PrimaryContactPartyNumber": null,
"PrimaryContactPartyName": null,
"StripeCd": "ORA_SVC_CRM",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceProfiles/CDRM_861007",
"name": "serviceProfiles",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceProfiles/CDRM_861007",
"name": "serviceProfiles",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceProfiles/CDRM_861007/child/contacts",
"name": "contacts",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceProfiles/CDRM_861007/child/notes",
"name": "notes",
"kind": "collection"
}
]
}