Create a service profile
post
/crmRestApi/resources/11.13.18.05/serviceProfiles
Request
Header Parameters
-
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.
-
Upsert-Mode:
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
- application/json
Root Schema : schema
Type:
Show Source
object
-
BillToCustomerAccountId: integer
(int64)
Title:
Bill-to Customer Account ID
The customer account to be billed for work performed for the service profile. -
BillToCustomerAccountNumber: string
Title:
Bill-to Customer Account Number
Maximum Length:30
The PUID for the customer account to be billed for work performed for the service profile. -
BillToCustomerAccountSiteId: integer
(int64)
Title:
Bill-to Customer Account Site ID
The customer account site to be billed for work performed for the service profile. -
BillToCustomerId: integer
(int64)
Title:
Bill-to Customer ID
The customer to be billed for work performed for the service profile. -
BillToPartySiteId: integer
(int64)
Title:
Bill-To Party Site ID
The party site to be billed for work performed for the service profile. -
contacts: array
Service Profile Contacts
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. -
CustomerPartyId(required): integer
(int64)
Title:
Customer Party ID
The customer having the service profile. -
CustomerPartyType(required): string
Title:
Customer Party Type
Maximum Length:30
Indicates whether the service profile customer is a person or organization. -
notes: array
Notes
Title:
Notes
The note objects resource is used to view the note objects. -
PartySiteId: integer
(int64)
Title:
Party Site ID
The site address of the service profile. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
The primary contact of the service profile. -
ServiceProfileName(required): string
Title:
Service Profile Name
Maximum Length:400
The name of the service profile. -
ServiceProfileNumber(required): string
Title:
Service Profile Number
Maximum Length:30
The PUID of the service profile. -
StatusCd: string
Title:
Status Code
Maximum Length:30
Default Value:ORA_SVC_ACTIVE
Indicates whether the service profile is active. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
Default Value:ORA_SVC_CRM
Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile. -
TypeCd: string
Title:
Type CD
Maximum Length:30
Default Value:ORA_SVC_SITE
The type of service profile.
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 : schema
Type:
Show Source
object
-
PartyId: integer
(int64)
Title:
Party ID
The contact for the service profile contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates the contact is the primary contact for the service profile. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The service profile for the service profile contact. -
ServiceProfileNumber: string
Title:
Service Profile Number
Maximum Length:30
The PUID of the service profile for the service profile contact.
Nested Schema : serviceProfiles-notes-item-post-request
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code for extensibility. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code for extensibility. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the note. This is the primary key of the notes table. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the parent source object associated to the note. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Response
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
-
BillToAccountSiteFormattedAddress: string
Title:
Bill-to Account Site Formatted Address
Read Only:true
Maximum Length:1000
The formatted address to be billed for work performed for the service profile. -
BillToCustomerAccountDescription: string
Title:
Bill-to Customer Account Description
Read Only:true
Maximum Length:240
The description of the customer account to be billed for work performed for the service profile. -
BillToCustomerAccountId: integer
(int64)
Title:
Bill-to Customer Account ID
The customer account to be billed for work performed for the service profile. -
BillToCustomerAccountNumber: string
Title:
Bill-to Customer Account Number
Maximum Length:30
The PUID for the customer account to be billed for work performed for the service profile. -
BillToCustomerAccountSiteId: integer
(int64)
Title:
Bill-to Customer Account Site ID
The customer account site to be billed for work performed for the service profile. -
BillToCustomerId: integer
(int64)
Title:
Bill-to Customer ID
The customer to be billed for work performed for the service profile. -
BillToCustomerPartyName: string
Title:
Bill-to Customer Party Name
Read Only:true
Maximum Length:360
The name of the customer to be billed for work performed for the service profile. -
BillToCustomerPartyNumber: string
Title:
Bill-to Customer Registry Number
Read Only:true
Maximum Length:30
The PUID for the customer to be billed for work performed for the service profile. -
BillToCustomerPartyUniqueName: string
Title:
Bill-to Customer Party Unique Name
Read Only:true
Maximum Length:900
The unique name of the customer to be billed for work performed for the service profile. -
BillToPartySiteId: integer
(int64)
Title:
Bill-To Party Site ID
The party site to be billed for work performed for the service profile. -
BillToPartySiteName: string
Title:
Bill-to Party Site Name
Read Only:true
Maximum Length:240
The name given to the party site that will be billed for work performed for the service profile. -
BillToPartySiteNumber: string
Title:
Bill-to Party Site Number
Read Only:true
Maximum Length:30
The PUID for the party site that will be billed for work performed for the service profile. -
contacts: array
Service Profile Contacts
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the service profile. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the service profile was created. -
CustomerPartyId: integer
(int64)
Title:
Customer Party ID
The customer having the service profile. -
CustomerPartyName: string
Title:
Customer Name
Read Only:true
Maximum Length:360
The name of the service profile customer. -
CustomerPartyNumber: string
Title:
Customer Registry Number
Read Only:true
Maximum Length:30
The PUID for the customer party of the service profile. -
CustomerPartyType: string
Title:
Customer Party Type
Maximum Length:30
Indicates whether the service profile customer is a person or organization. -
CustomerPartyUniqueName: string
Title:
Customer Unique Name
Read Only:true
Maximum Length:900
The unique name of the service profile customer. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the service profile was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service profile. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the service profile. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
notes: array
Notes
Title:
Notes
The note objects resource is used to view the note objects. -
PartySiteAddress1: string
Title:
Address1
Read Only:true
Maximum Length:240
The first address line for the service profile site address. -
PartySiteAddress2: string
Title:
Address2
Read Only:true
Maximum Length:240
The second address line for the service profile site address. -
PartySiteAddress3: string
Title:
Address3
Read Only:true
Maximum Length:240
The third address line for the service profile site address. -
PartySiteAddress4: string
Title:
Address4
Read Only:true
Maximum Length:240
The fourth address line for the service profile site address. -
PartySiteBuilding: string
Title:
Building
Read Only:true
Maximum Length:240
The building information for the service profile site address. -
PartySiteCity: string
Title:
City
Read Only:true
Maximum Length:60
The city for the service profile site address. -
PartySiteCountry: string
Title:
Country
Read Only:true
Maximum Length:2
The country for the service profile site address. -
PartySiteCounty: string
Title:
County
Read Only:true
Maximum Length:60
The county for the service profile site address. -
PartySiteFloorNumber: string
Title:
Floor Number
Read Only:true
Maximum Length:40
The floor in the building for the service profile site address. -
PartySiteFormattedAddress: string
Title:
Party Site Formatted Address
Read Only:true
Maximum Length:1000
The formatted site address of the service profile. -
PartySiteId: integer
(int64)
Title:
Party Site ID
The site address of the service profile. -
PartySiteLatitude: number
Title:
Latitude
Read Only:true
The latitude coordinate for the service profile site address. -
PartySiteLocationId: integer
(int64)
Title:
Site Location ID
Read Only:true
The location identifier for the service profile site address. -
PartySiteLongitude: number
Title:
Longitude
Read Only:true
The longitude coordinate for the service profile site address. -
PartySiteName: string
Title:
Site Name
Read Only:true
Maximum Length:240
The name given to the service profile site address. -
PartySiteNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The PUID of the service profile site address. -
PartySitePartyId: integer
(int64)
Title:
Site Party ID
Read Only:true
The party of the service profile site address. -
PartySitePartyName: string
Title:
Site Party Name
Read Only:true
Maximum Length:360
The name of the party of the service profile site address. -
PartySitePartyUniqueName: string
Title:
Site Party Unique Name
Read Only:true
Maximum Length:900
The unique name of the part of the service profile site address. -
PartySitePostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code for the service profile site address. -
PartySiteProvince: string
Title:
Province
Read Only:true
Maximum Length:60
The province for the service profile site address. -
PartySiteState: string
Title:
State
Read Only:true
Maximum Length:60
The state for the service profile site address. -
PartySiteTimezoneCode: string
Title:
Time Zone Code
Read Only:true
Maximum Length:64
The time zone for the service profile site address. -
PartySiteUse: string
Title:
Address Type
Read Only:true
Maximum Length:750
The type of address stored for the service profile site address. -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
The primary contact of the service profile. -
PrimaryContactPartyName: string
Title:
Primary Contact Name
Read Only:true
Maximum Length:360
The name of the service profile primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party Number
Read Only:true
Maximum Length:30
The party number of the service profile primary contact. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
Read Only:true
The unique identifier of the service profile. -
ServiceProfileName: string
Title:
Service Profile Name
Maximum Length:400
The name of the service profile. -
ServiceProfileNumber: string
Title:
Service Profile Number
Maximum Length:30
The PUID of the service profile. -
StatusCd: string
Title:
Status Code
Maximum Length:30
Default Value:ORA_SVC_ACTIVE
Indicates whether the service profile is active. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
Default Value:ORA_SVC_CRM
Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile. -
TypeCd: string
Title:
Type CD
Maximum Length:30
Default Value:ORA_SVC_SITE
The type of service profile.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The note objects resource is used to view the note objects.
Show Source
Nested Schema : serviceProfiles-contacts-item-response
Type:
Show Source
object
-
ContactEmailAddress: string
Title:
Contact Email Address
Read Only:true
Maximum Length:320
The email address of the contact belonging to the service profile. -
ContactFormattedPhoneNumber: string
Title:
Phone Number
Read Only:true
The phone number of the contact belonging to the service profile. -
ContactPartyName: string
Title:
Contact Name
Read Only:true
Maximum Length:360
The name of the contact belonging to the service profile. -
ContactPartyNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
The PUID of the contact belonging to the service profile. -
ContactPartyUniqueName: string
Title:
Contact Unique Name
Read Only:true
Maximum Length:900
The unique name of the contact belonging to the service profile. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user that created the service profile contact. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the service profile contact was created. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The job title of the contact belonging to the service profile. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the service profile contact was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the service profile contact. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the service profile contact. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The contact for the service profile contact. -
PrimaryContactFlag: boolean
Title:
Primary
Indicates the contact is the primary contact for the service profile. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The service profile for the service profile contact. -
ServiceProfileName: string
Title:
Service Profile Name
Read Only:true
Maximum Length:400
The name of the service profile for the service profile contact. -
ServiceProfileNumber: string
Title:
Service Profile Number
Maximum Length:30
The PUID of the service profile for the service profile contact. -
SpContactId: integer
(int64)
Title:
Service Profile Contact ID
Read Only:true
The unique identifier of the service profile contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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 ID
The relationship ID populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code for extensibility. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type for extensibility. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code for extensibility. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the note. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The unique identifier of the note. This is the primary key of the notes table. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the note. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the note. This is the primary key of the notes table. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of the party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
This is the source object code for the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the parent source object associated to the note. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user can update the note. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.
Nested Schema : Links
Type:
array
Title:
Links
The 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:
- ServiceProfileNumber:
$request.path.ServiceProfileNumber
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. - ServiceProfileNumber:
- notes
-
Parameters:
- ServiceProfileNumber:
$request.path.ServiceProfileNumber
The note objects resource is used to view the note objects. - ServiceProfileNumber: