Create an asset resource
post
/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetResources
Request
Path Parameters
-
AssetId(required): integer(int64)
The unique identifier of the asset.
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.
-
Upsert-Mode: string
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-
AssetId(required): integer
(int64)
Title:
Asset IDThe unique identifier of the Asset. -
AssetResourceId: integer
(int64)
Title:
Asset Resource IDThe unique identifier of the resource associated with the asset. -
EmailAddress: string
Title:
EmailThe e-mail address of the asset team member. -
MemberFunctionCode: string
Title:
FunctionMaximum Length:30The code indicating the role of an asset resource in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of valid values is defined in the lookup FND_LOOKUPS. -
OwnerFlag: boolean
Title:
OwnerIndicates whether the asset resource is the owner of the asset. -
ResourceId(required): integer
(int64)
Title:
Resource Party IDThe identifier of the party associated with the asset resource. -
smartActions: array
Smart Actions
Title:
Smart ActionsThe smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThe smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : assets-assetResources-smartActions-item-post-request
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:4000The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content TypeMaximum Length:50The media type of the smart action REST operation. -
DisplayLabel(required): string
Title:
Action NameMaximum Length:256The display name of the smart action. -
Entity: string
Title:
Parent EntityMaximum Length:150The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST EndpointMaximum Length:1024The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512The client applications that the smart action is associated with. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Indicates if the action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function for 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 whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action IDThe unique identifier of the smart action definition. -
UserActionName(required): string
Title:
Action NameMaximum Length:256The unique identifier of the smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityThe number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
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 : 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 : assets-assetResources-smartActions-UserActionRequestPayload-item-post-request
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseIndicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : assets-assetResources-smartActions-UserActionURLBinding-item-post-request
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseIndicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000The value assigned to the value property of a name-value pair.
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 : assets-assetResources-item-response
Type:
Show Source
object-
AssetId: integer
(int64)
Title:
Asset IDThe unique identifier of the Asset. -
AssetNumber: string
Title:
Asset NumberRead Only:trueMaximum Length:100The number that identifies the asset. -
AssetResourceId: integer
(int64)
Title:
Asset Resource IDThe unique identifier of the resource associated with the asset. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created or imported the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the record was created. -
EmailAddress: string
Title:
EmailThe e-mail address of the asset team member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login details of the user who last updated the record in the interface table or submitted the import process. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MemberFunctionCode: string
Title:
FunctionMaximum Length:30The code indicating the role of an asset resource in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of valid values is defined in the lookup FND_LOOKUPS. -
OwnerFlag: boolean
Title:
OwnerIndicates whether the asset resource is the owner of the asset. -
PartyId: integer
(int64)
Title:
Party IDRead Only:trueThe unique identifier of the account, or contact associated with the asset. -
PartyName: string
Title:
NameRead Only:trueMaximum Length:360The name of the party associated with the asset resource. -
PrimaryPhoneAreaCode: string
Title:
Primary Phone Area CodeRead Only:trueMaximum Length:20The phone area code of the asset resource. -
PrimaryPhoneCountryCode: string
Title:
Primary Phone Country CodeRead Only:trueMaximum Length:10The phone country code of the asset resource. -
PrimaryPhoneExtension: string
Title:
ExtensionRead Only:trueMaximum Length:20The phone extension code of the asset resource. -
PrimaryPhoneLineType: string
Title:
Phone Line TypeRead Only:trueMaximum Length:30The type of the phone line of the asset resource. -
PrimaryPhoneNumber: string
Title:
PhoneRead Only:trueMaximum Length:40The primary phone number of the asset team member. -
ResourceId: integer
(int64)
Title:
Resource Party IDThe identifier of the party associated with the asset resource. -
ResourcePartyNumber: string
Title:
Resource Party NumberRead Only:trueMaximum Length:30The unique identifier of the resource associated with the asset. -
RoleName: string
Title:
TitleRead Only:trueThe name of the role of an asset resource in the resource team. -
smartActions: array
Smart Actions
Title:
Smart ActionsThe smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
Status: string
Title:
Party StatusRead Only:trueMaximum Length:1The user-defined status of the asset team member.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThe smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
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 : assets-assetResources-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:4000The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content TypeMaximum Length:50The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action NameMaximum Length:256The display name of the smart action. -
Entity: string
Title:
Parent EntityMaximum Length:150The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST EndpointMaximum Length:1024The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512The client applications that the smart action is associated with. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Indicates if the action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function for 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 whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action IDThe unique identifier of the smart action definition. -
UserActionName: string
Title:
Action NameMaximum Length:256The unique identifier of the smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityThe number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsThe payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter DefinitionsThe path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
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 DefinitionsThe payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
arrayTitle:
Smart Action REST Path Parameter DefinitionsThe path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : assets-assetResources-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseIndicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : assets-assetResources-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseIndicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- MemberFunctionLOV
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DORA_ZCM_TEAM_FUNCTION
The lookups resource is used to view standard lookup codes. - finder:
- smartActions
-
Parameters:
- AssetId:
$request.path.AssetId - AssetResourceId:
$request.path.AssetResourceId
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. - AssetId:
Examples
The following example shows how to create an asset resource by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/assets/785805215/child/assetResources
Example of Request Body
The following example shows the contents of the request body in JSON format.
{
"ResourceId": 2448
}Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"AssetResourceId": 300100168153876,
"AssetId": 785805215,
"ResourceId": 2448,
"MemberFunctionCode": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2018-09-25T10:00:45+00:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2018-09-25T10:00:45.346+00:00",
"LastUpdateLogin": "76AF2964E73B33C2E053773AF80A77BF",
"PartyName": "Lisa Smith",
"PartyId": 2448,
"Status": "A",
"EmailAddress": "sendmail-test-discard@oracle.com",
"PrimaryPhoneNumber": "5558355",
"PrimaryPhoneAreaCode": "800",
"PrimaryPhoneCountryCode": "1",
"PrimaryPhoneExtension": null,
"PrimaryPhoneLineType": "GEN",
"OwnerFlag": false,
"RoleName": "Salesperson",
"ResourcePartyNumber": "CONTACT-1010",
"links": [
...
]
}