REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Create a resource member

post

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/resourceMembers

Request

Path Parameters

SrNumber(required): string

The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.

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: object

Show Source

MemberId: integer (int64)

Title: Member ID

A unique identifier service request resource member record.
ObjectId: integer (int64)

Title: Service Request Team Member Resource ID

The unique identifier of the individual resource added as service request resource member.
OwnerFlag: boolean

Title: Assigned To

Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False.
ResourceName: string

Title: Name

Maximum Length: 360

The name of the individual resource added as service request resource member.
SrId: integer (int64)

Title: Service Request ID

The unique identifier of the service request that the resource is associated with.
SrNumber: string

Title: Service Request Number

Maximum Length: 30

The public unique identifier of the service request number.

{
    "type":"object",
    "properties":{
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"A unique identifier service request resource member record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectId":{
            "title":"Service Request Team Member Resource ID",
            "type":"integer",
            "description":"The unique identifier of the individual resource added as service request resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the individual resource added as service request resource member.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OwnerFlag":{
            "title":"Assigned To",
            "type":"boolean",
            "description":"Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ObjectId"
                ]
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request that the resource is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service request number.",
            "nullable":false
        }
    }
}

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 : serviceRequests-resourceMembers-item-response

Type: object

Show Source

CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who added the resource as a member of the service request.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the service request resource member was created.
DeleteFlag: boolean

Title: Can Delete

Read Only: true

Indicates if the resource member has been deleted.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the service request resource member record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the service request resource member record.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The application login associated with the user who last updated the service request resource member.
links: array Links

Title: Links

The link relations associated with the resource instance.
MemberId: integer (int64)

Title: Member ID

A unique identifier service request resource member record.
ObjectId: integer (int64)

Title: Service Request Team Member Resource ID

The unique identifier of the individual resource added as service request resource member.
ObjectTypeCd: string

Title: Object Type

Read Only: true

Maximum Length: 30

Default Value: ORA_SVC_RESOURCE

The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .
OwnerFlag: boolean

Title: Assigned To

Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False.
PartyUniqueName: string

Title: Unique Party Name

Read Only: true

Maximum Length: 900

The unique name of the individual resource added as service request resource member.
ResourceEmailAddress: string

Title: Email

Read Only: true

Maximum Length: 320

The email address of the resource member.
ResourceFormattedAddress: string

Title: Resource Formatted Address

Read Only: true

Indicates the formatted address of the service request resource member.
ResourceFormattedPhoneNumber: string

Title: Phone

Read Only: true

The formatted phone number of the resource member.
ResourceName: string

Title: Name

Maximum Length: 360

The name of the individual resource added as service request resource member.
ResourcePartyNumber: string

Title: Resource Number

Read Only: true

Maximum Length: 30

The public unique identifier of the service request team member.
SrId: integer (int64)

Title: Service Request ID

The unique identifier of the service request that the resource is associated with.
SrNumber: string

Title: Service Request Number

Maximum Length: 30

The public unique identifier of the service request number.
UpdateFlag: boolean

Title: Can Update

Read Only: true

Indicates if the resource member has been updated.
UserGUID: string

Title: User GUID

Read Only: true

Maximum Length: 64

A globally unique identifier of the resource added as the service request resource member.
UserId: integer (int64)

Title: User ID

Read Only: true

The user identifier of the resource added as the service request resource member.
Username: string

Title: User Name

Read Only: true

Maximum Length: 100

The user name of the resource member.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the service request resource member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the service request resource member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who added the resource as a member of the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Service Request Team Member Resource ID",
            "type":"integer",
            "description":"The unique identifier of the individual resource added as service request resource member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserGUID":{
            "title":"User GUID",
            "maxLength":"64",
            "type":"string",
            "description":"A globally unique identifier of the resource added as the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the individual resource added as service request resource member.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Assigned To",
            "type":"boolean",
            "description":"Indicates if the service request is assigned to the resource member. If yes, the value is True, else the value is False.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ObjectId"
                ]
            }
        },
        "PartyUniqueName":{
            "title":"Unique Party Name",
            "maxLength":"900",
            "type":"string",
            "description":"The unique name of the individual resource added as service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceFormattedAddress":{
            "title":"Resource Formatted Address",
            "type":"string",
            "description":"Indicates the formatted address of the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceCountry",
                    "ResourceIdenAddrLocationId",
                    "ResourcePersonalAddressFlag"
                ]
            }
        },
        "ResourceEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service request number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the resource member has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"A unique identifier service request resource member record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the resource member has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Username":{
            "title":"User Name",
            "maxLength":"100",
            "type":"string",
            "description":"The user name of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "title":"User ID",
            "type":"integer",
            "description":"The user identifier of the resource added as the service request resource member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the resource member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResourcePersonalPhoneFlag",
                    "ResourcePrimaryPhoneAreaCode",
                    "ResourcePrimaryPhoneContactPtId",
                    "ResourcePrimaryPhoneCountryCode",
                    "ResourcePrimaryPhoneExtension",
                    "ResourcePrimaryPhoneLineType",
                    "ResourcePrimaryPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether the resource is an individual or a team. A list of accepted values is defined in the lookup ORA_SVC_RES_OBJECT_TYPE_CD .",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_RESOURCE",
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service request team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request that the resource is associated with.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the service request resource member record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The application login associated with the user who last updated the service request resource member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ObjectTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

finder: LookupTypeFinder%3BLookupType%3DORA_SVC_RES_OBJECT_TYPE_CD

The list of values indicating the resource object type such as an individual or a team.

ResourcePickerPVO

Operation: /crmRestApi/resources/11.13.18.05/resources

The list of values of the service request resource member names.

Examples

The following example shows how to create a resource member by submitting a POST request on the REST resource.

Example of Request Header

The following shows an example of the request header.

POST /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers 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 example shows the contents of the request body in JSON format.

{
"ObjectId":"100010032752719"
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201: Created
Date: Thu, 06 Oct 2016 10:35:19 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

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

{
"MemberId": 300100093660874
"SrId": 300100092156941
"ObjectTypeCd": "ORA_SVC_RESOURCE"
"ObjectId": 100010032752719
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-10-06T04:34:47-07:00"
"LastUpdatedBy": "SALES_ADMIN"
"LastUpdateDate": "2016-10-06T04:34:47-07:00"
"LastUpdateLogin": "3E083FEE298B780EE053780CF10A584A"
"ResourceName": "Mitchell,Edwin"
"PartyUniqueName": null
"ResourceEmailAddress": "edwin.mitchell@us2.oraclecloud.com"
"ResourceFormattedPhoneNumber": null
"UserGUID": "9D3259317858A6899ACB1F146A9A3FA0"
"UserId": 100010032752113
"Username": "EMitch"
"OwnerFlag": false
"links": 
[
5]
0:  
{
"rel": "self"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100093660874"
"name": "resourceMembers"
"kind": "item"
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
-
}
-
1:  
{
"rel": "canonical"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100093660874"
"name": "resourceMembers"
"kind": "item"
}
-
2:  
{
"rel": "parent"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002"
"name": "serviceRequests"
"kind": "item"
}
-
3:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100093660874/lov/ResourcePickerPVO"
"name": "ResourcePickerPVO"
"kind": "collection"
}
-
4:  
{
"rel": "lov"
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/resourceMembers/300100093660874/lov/ObjectTypeLookup"
"name": "ObjectTypeLookup"
"kind": "collection"
}
-
-
}