Service Profiles
serviceProfiles Based on latest (2026.09)
Create, change, delete and look up Service Profiles, with contacts, notes and smart actions.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE9 actions
- Record key
serviceProfiles_Id- Required on create
CustomerPartyIdCustomerPartyTypeServiceProfileNameServiceProfileNumber- At a glance
- 58 fields2 finders6 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/serviceProfiles?fields=BillToAccountSiteFormattedAddress,BillToCustomerAccountDescription,BillToCustomerAccountId,BillToCustomerAccountNumber,BillToCustomerAccountSiteId&limit=25&onlyData=true
{
"items": [
{
"BillToAccountSiteFormattedAddress": "<string, max 1000>",
"BillToCustomerAccountDescription": "<string, max 240>",
"BillToCustomerAccountId": 0,
"BillToCustomerAccountNumber": "<string, max 30>",
"BillToCustomerAccountSiteId": 0
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 58
| Attribute | Type | Use |
|---|---|---|
BillToAccountSiteFormattedAddress | text · max 1000 | Read-onlySearchable |
BillToCustomerAccountDescription | text · max 240 | Read-onlySearchable |
BillToCustomerAccountId | number | Optional on createUpdatableSearchable |
BillToCustomerAccountNumber | text · max 30 | Optional on createUpdatableSearchable |
BillToCustomerAccountSiteId | number | Optional on createUpdatableSearchable |
BillToCustomerId | number | Optional on createUpdatableSearchable |
BillToCustomerPartyName | text · max 360 | Read-onlySearchable |
BillToCustomerPartyNumber | text · max 30 | Read-onlySearchable |
BillToCustomerPartyUniqueName | text · max 900 | Read-onlySearchable |
BillToPartySiteId | number | Optional on createUpdatableSearchable |
BillToPartySiteName | text · max 240 | Read-onlySearchable |
BillToPartySiteNumber | text · max 30 | Read-onlySearchable |
BillingBUOrgId | number | Optional on createUpdatableSearchable |
BillingBusinessUnitName | text · max 240 | Read-only |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CustomerPartyId | number | Required on createSearchable |
CustomerPartyName | text · max 360 | Read-onlySearchable |
CustomerPartyNumber | text · max 30 | Read-onlySearchable |
CustomerPartyType | text · max 30 | Required on createUpdatableSearchable |
CustomerPartyUniqueName | text · max 900 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
PartySiteAddress1 | text · max 240 | Read-onlySearchable |
PartySiteAddress2 | text · max 240 | Read-onlySearchable |
PartySiteAddress3 | text · max 240 | Read-onlySearchable |
PartySiteAddress4 | text · max 240 | Read-onlySearchable |
PartySiteBuilding | text · max 240 | Read-onlySearchable |
PartySiteCity | text · max 60 | Read-onlySearchable |
PartySiteCountry | text · max 2 | Read-onlySearchable |
PartySiteCounty | text · max 60 | Read-onlySearchable |
PartySiteFloorNumber | text · max 40 | Read-onlySearchable |
PartySiteFormattedAddress | text · max 1000 | Read-onlySearchable |
PartySiteId | number | Optional on createSearchable |
PartySiteLatitude | number | Read-onlySearchable |
PartySiteLocationId | number | Read-onlySearchable |
PartySiteLongitude | number | Read-onlySearchable |
PartySiteName | text · max 240 | Read-onlySearchable |
PartySiteNumber | text · max 30 | Read-onlySearchable |
PartySitePartyId | number | Read-onlySearchable |
PartySitePartyName | text · max 360 | Read-onlySearchable |
PartySitePartyUniqueName | text · max 900 | Read-onlySearchable |
PartySitePostalCode | text · max 60 | Read-onlySearchable |
PartySiteProvince | text · max 60 | Read-onlySearchable |
PartySiteState | text · max 60 | Read-onlySearchable |
PartySiteTimezoneCode | text · max 64 | Read-onlySearchable |
PartySiteUse | text · max 750 | Read-only |
PrimaryContactPartyId | number | Optional on createUpdatableSearchable |
PrimaryContactPartyName | text · max 360 | Read-onlySearchable |
PrimaryContactPartyNumber | text · max 30 | Read-onlySearchable |
ServiceProfileId | number | Read-onlySearchable |
ServiceProfileName | text · max 400 | Required on createUpdatableSearchable |
ServiceProfileNumber | text · max 30 | Required on createSearchable |
StatusCd | text · max 30 · default ORA_SVC_ACTIVE | Optional on createUpdatableSearchable |
StripeCd | text · max 30 · default ORA_SVC_CRM | Optional on createUpdatableSearchable |
TypeCd | text · max 30 · default ORA_SVC_SITE | Optional on createUpdatableSearchable |
TypeCdMeaning | text | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ServiceProfileAltKeyFinder·CustomerPartyNumberPartySiteNumberServiceProfileByNumber·ServiceProfileNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 6
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/serviceProfiles/{serviceProfiles_Id}/child/<name>. Add them to a GET with expand.
contactsGET · POST · PATCH · DELETE Service Profile Contacts · 17 fields · 1 findersContactEmailAddressContactFormattedPhoneNumberContactPartyNameContactPartyNumberContactPartyUniqueNameCreatedByCreationDateJobTitleLastUpdateDateLastUpdateLoginLastUpdatedByPartyIdPrimaryContactFlagServiceProfileIdServiceProfileNameServiceProfileNumberSpContactIdnotesGET · POST · PATCH · DELETE Notes · 27 fieldsContactRelationshipIdCorpCurrencyCodeCreatedByCreationDateCreatorPartyIdCurcyConvRateTypeCurrencyCodeDeleteFlagEmailAddressFormattedAddressFormattedPhoneNumberLastUpdateDateLastUpdateLoginLastUpdatedByNoteIdNoteNumberNoteTitleNoteTxtNoteTypeCodeParentNoteIdPartyIdPartyNameSourceObjectCodeSourceObjectIdSourceSystemUpdateFlagVisibilityCodesmartActionsGET Smart Actions · 17 fields · 1 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fieldsSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fieldsBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fieldsBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 9
POST …/{serviceProfiles_Id}/child/smartActions/action/executeActionForRows·payloadPOST …/{serviceProfiles_Id}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{serviceProfiles_Id}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{serviceProfiles_Id}/child/smartActions/action/getActionsForRows·payloadPOST …/{serviceProfiles_Id}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{serviceProfiles_Id}/child/smartActions/action/getEntitiesPOST …/{serviceProfiles_Id}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{serviceProfiles_Id}/child/smartActions/action/processMassAction·payloadPOST …/{serviceProfiles_Id}/child/smartActions/{serviceProfiles_smartActions_Id}/action/executeAction
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/serviceProfilesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ServiceProfileAltKeyFinderfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:BillToCustomerAccountId, notbilltocustomeraccountid. - 43 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.