Create a role for a self-service user
post
/crmRestApi/resources/11.13.18.05/selfServiceRoles
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
-
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account of the self-service user associated with the role. -
ContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact record of the self-service user associated with the role. -
LoginId: string
Title:
Login ID
Maximum Length:320
The login Id of the self-service user associated with the role. -
RelationshipTypeCd: string
Title:
Relationship Type
Maximum Length:320
The code indicating the type of role. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD. -
RequestTypeCd: string
Title:
Request Type
Maximum Length:30
The code indicating the type of registration request. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REQ_TYPE_CD.
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 : selfServiceRoles-item-response
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account of the self-service user associated with the role. -
AccountPartyName: string
Title:
Account
Read Only:true
Maximum Length:360
The account party name associated with the role. -
AccountPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The unique identifier of the account of the self-service user associated with the role. -
CanDeleteFlag: boolean
Title:
Can Delete
Read Only:true
Default Value:true
Indicates if the record can be deleted. -
CanUpdateFlag: boolean
Title:
Can Update
Read Only:true
Default Value:false
Indicates if the record can be updated. The default value is false. -
ContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact record of the self-service user associated with the role. -
ContactPartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the account of the self-service user associated with the role. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The unique identifier of the contact record of the self-service user associated with the role. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the role record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the role record was created. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the self-service user associated with the role. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The date when the role was deleted from the user. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the role record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
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. -
LoginId: string
Title:
Login ID
Maximum Length:320
The login Id of the self-service user associated with the role. -
RegistrationId: integer
(int64)
Title:
Registration ID
Read Only:true
The unique identifier of the self-service registration request whose approval was used to grant the role. -
RelationshipTypeCd: string
Title:
Relationship Type
Maximum Length:320
The code indicating the type of role. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD. -
RelationshipTypeCdMeaning: string
Title:
Role Value
Read Only:true
Maximum Length:80
The code indicating the role type. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REL_TYPE_CD. -
RequestTypeCd: string
Title:
Request Type
Maximum Length:30
The code indicating the type of registration request. The list of accepted values is defined in the lookup type ORA_SVC_CSS_REQ_TYPE_CD. -
RoleId: integer
(int64)
Title:
Role ID
Read Only:true
The unique identifier of the role. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the self service role starts.
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.
Links
- RelationshipTypeCDLookupVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SVC_CSS_REL_TYPE_CD
The list of values indicating the type of relationship. The lookup type is ORA_SVC_CSS_REL_TYPE_CD.
The following properties are defined on the LOV link relation:- Source Attribute: RelationshipTypeCd; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
Use POST with the following URI syntax to create a role and add it to a self-service user:
Example of Request URI
The following shows an example of the request URL.
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles
Example of Request Header
The following shows an example of the request header.
POST crmRestApi/resources/11.13.18.05/selfServiceRoles HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Request Body
The following shows an example of the request body in JSON format.
Content type: { "AccountPartyId": "300100091492019", "ContactPartyId": "300100095936284", "RelationshipTypeCd": "ORA_CSS_ACC_ADMIN" }
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 201 CREATED Date: Fri, 17 Mar 2017 06:14:10 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following shows an example of the response body in JSON format.
Content type: { "AccountPartyId": 300100091492019, "ContactPartyId": 300100095936284, "CreatedBy": "css_dev_user@oracle.com", "CreationDate": "2017-03-16T23:14:16-07:00", "EndDate": null, "LastUpdateDate": "2017-03-16T23:14:16-07:00", "LastUpdateLogin": "4ADF2E4575BA2EAFE0530E8EF50AAAF4", "LastUpdatedBy": "css_dev_user@oracle.com", "RegistrationId": null, "RelationshipTypeCd": "ORA_CSS_ACC_ADMIN", "RoleId": 300100095936466, "StartDate": "2017-03-16", "AccountPartyName": "CSS ABCS Test 1", "ContactPartyName": "csstest123@oracle.com", "EmailAddress": "csstest123@oracle.com", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles/300100095936466", "name": "selfServiceRoles", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles/300100095936466", "name": "selfServiceRoles", "kind": "item" }, { "rel": "lov", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfServiceRoles/300100095936466/lov/RelationshipTypeCDLookupVO", "name": "RelationshipTypeCDLookupVO", "kind": "collection" } ] }