1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Assets

Get an asset

get

/crmRestApi/resources/11.13.18.05/assets/{AssetId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : assets-item-response
Type: object
Show Source
Nested Schema : Asset Activities
Type: array
Title: Asset Activities
The asset activities resource is used to view the activities of the asset. This is used to capture task and appointment information.
Show Source
Nested Schema : Asset Contacts
Type: array
Title: Asset Contacts
The asset contacts resource is used to view, create, update, and delete the contacts associated with an asset.
Show Source
Nested Schema : Asset Leads
Type: array
Title: Asset Leads
The asset leads resource is used to view an asset lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.
Show Source
Nested Schema : Asset Opportunities
Type: array
Title: Asset Opportunities
The asset opportunities resource is used to view the opportunities of an asset. An opportunity is used by a sales organization to track information about a potential sale such as the sales account, key contacts, product interests, and potential revenues.
Show Source
Nested Schema : Asset Resources
Type: array
Title: Asset Resources
Asset resources is used to view, create, update, and delete the team members associated with an asset.
Show Source
Nested Schema : Asset Service Requests
Type: array
Title: Asset Service Requests
The asset service requests resource is used to view the service requests related to an asset. These are header level information about a request from a customer for service from the time the customer makes the request until the request is resolved. For example, if a customer has an issue with their laptop battery draining too fast, the details of the customer and the issue they are facing is stored in the service request header.
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, update, and delete attachments of an asset. An attachment includes additional information about an asset.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
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.
Show Source
Nested Schema : assets-assetActivities-item-response
Type: object
Show Source
Nested Schema : assets-assetContacts-item-response
Type: object
Show Source
  • Title: Asset Contact ID
    The unique identifier of the primary contact associated with the asset.
  • Title: Asset ID
    The unique identifier of the Asset.
  • Title: Asset Number
    Read Only: true
    Maximum Length: 100
    The number that identifies the asset.
  • Title: Function
    Maximum Length: 30
    The code indicating the function of a contact. A list of valid values is defined in the lookup FunctionTypesLookupPVO.
  • Title: Contact Party ID
    The unique identifier of the party associated with the primary contact.
  • Title: Contact Party Number
    Read Only: true
    Maximum Length: 30
    The unique identifier of the contact associated with the asset.
  • Title: Contact Source System
    The system from where the contact associated with the asset is sourced.
  • Title: Contact Source System Reference
    The reference system from where the contact associated with the asset is sourced.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created or imported the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the primary contact associated with the asset.
  • Title: Phone
    Read Only: true
    The formatted phone number of the primary contact associated with the asset.
  • Title: Job Title
    Read Only: true
    Maximum Length: 100
    The title of the job of the asset contact.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the record in the interface table or submitted the import process.
  • Links
  • Title: Party ID
    Read Only: true
    The unique identifier of the account, or contact associated with the asset.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the party associated with the primary contact.
  • Title: Contact Party ID
    Read Only: true
    The unique identifier of the contacts profile.
  • Title: Primary
    Indicates whether the asset contact is the primary contact. If the value is true, then the asset contact is a primary contact.
  • Smart Actions
    Title: Smart Actions
    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.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
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.
Show Source
Nested Schema : assets-assetContacts-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The 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.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if the action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The 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.
  • Title: User Action ID
    The unique identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique identifier of the smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The 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.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The 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 : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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 Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The 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: array
Title: Smart Action REST Path Parameter Definitions
The 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-assetContacts-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : assets-assetContacts-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The 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
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A 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-assetContacts-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The 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
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : assets-assetLeads-item-response
Type: object
Show Source
Nested Schema : assets-assetOpportunities-item-response
Type: object
Show Source
Nested Schema : assets-assetResources-item-response
Type: object
Show Source
  • Title: Asset ID
    The unique identifier of the Asset.
  • Title: Asset Number
    Read Only: true
    Maximum Length: 100
    The number that identifies the asset.
  • Title: Asset Resource ID
    The unique identifier of the resource associated with the asset.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created or imported the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Email
    The e-mail address of the asset team member.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the record in the interface table or submitted the import process.
  • Links
  • Title: Function
    Maximum Length: 30
    The 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.
  • Title: Owner
    Indicates whether the asset resource is the owner of the asset.
  • Title: Party ID
    Read Only: true
    The unique identifier of the account, or contact associated with the asset.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the party associated with the asset resource.
  • Title: Primary Phone Area Code
    Read Only: true
    Maximum Length: 20
    The phone area code of the asset resource.
  • Title: Primary Phone Country Code
    Read Only: true
    Maximum Length: 10
    The phone country code of the asset resource.
  • Title: Extension
    Read Only: true
    Maximum Length: 20
    The phone extension code of the asset resource.
  • Title: Phone Line Type
    Read Only: true
    Maximum Length: 30
    The type of the phone line of the asset resource.
  • Title: Phone
    Read Only: true
    Maximum Length: 40
    The primary phone number of the asset team member.
  • Title: Resource Party ID
    The identifier of the party associated with the asset resource.
  • Title: Resource Party Number
    Read Only: true
    Maximum Length: 30
    The unique identifier of the resource associated with the asset.
  • Title: Title
    Read Only: true
    The name of the role of an asset resource in the resource team.
  • Smart Actions
    Title: Smart Actions
    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.
  • Title: Party Status
    Read Only: true
    Maximum Length: 1
    The user-defined status of the asset team member.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
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.
Show Source
Nested Schema : assets-assetResources-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The 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.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if the action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The 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.
  • Title: User Action ID
    The unique identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique identifier of the smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The 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.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The 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 : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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 Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The 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: array
Title: Smart Action REST Path Parameter Definitions
The 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-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : assets-assetResources-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The 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
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A 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-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The 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
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Nested Schema : assets-assetServiceRequests-item-response
Type: object
Show Source
Nested Schema : assets-attachments-item-response
Type: object
Show Source
Nested Schema : assets-smartActions-item-response
Type: object
Show Source
  • Title: Action Intent
    JSON object that describes what an action does and what context data can be passed to the action.
  • Title: Confirmation Message
    Maximum Length: 4000
    The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
  • Title: Content Type
    Maximum Length: 50
    The media type of the smart action REST operation.
  • Title: Action Name
    Maximum Length: 256
    The display name of the smart action.
  • Title: Parent Entity
    Maximum Length: 150
    The 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.
  • Title: REST Endpoint
    Maximum Length: 1024
    The relative path of the smart action REST resource. The path can include path parameters.
  • Title: Included in Application
    Maximum Length: 512
    The client applications that the smart action is associated with.
  • Links
  • Title: Mass Action
    Maximum Length: 1
    Indicates if the action can be mass processed.
  • Title: HTTP Method
    Maximum Length: 15
    The HTTP method of the smart action REST operation.
  • Title: Object Function
    Maximum Length: 64
    The object function for smart action.
  • Title: Page Type
    Maximum Length: 256
    The list of pages that this action can be used in.
  • Title: Smart Suggest
    Maximum Length: 1
    Indicates whether the smart suggest is enabled for the action.
  • Title: System Action
    Maximum Length: 1
    System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
  • Title: Attributes to Update
    Maximum Length: 512
    The 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.
  • Title: User Action ID
    The unique identifier of the smart action definition.
  • Title: Action Name
    Maximum Length: 256
    The unique identifier of the smart action name.
  • Smart Action User Interface Definitions
    Title: Smart Action User Interface Definitions
    The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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.
  • Title: Priority
    The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
  • Smart Action REST Payload Definitions
    Title: Smart Action REST Payload Definitions
    The 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.
  • Smart Action REST Path Parameter Definitions
    Title: Smart Action REST Path Parameter Definitions
    The 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 : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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 Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
The 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: array
Title: Smart Action REST Path Parameter Definitions
The 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-smartActions-UserActionNavigation-item-response
Type: object
Show Source
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Application Usage
    Maximum Length: 50
    The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
  • Title: Navigation Metadata
    Maximum Length: 1000
    The metadata definition of the smart action user interface endpoint.
  • Title: Primary Key
    The unique identifier of a smart action user interface definition.
  • Title: Navigation Type
    Maximum Length: 100
    The text value used by applications to determine which user interface to launch.
Nested Schema : assets-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The 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
  • Title: Mandatory
    Maximum Length: 1
    Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
  • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
  • Title: Payload Value Structure
    Maximum Length: 20
    A 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-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The 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
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
  • The unique identifier of a smart action REST path parameter name-value pair definition.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The value assigned to the name property of a name-value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value assigned to the value property of a name-value pair.
Links
AssetGroupVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{AssetGroup}%2CBindLookupType%3DORA_ASSET_SALES_GROUP
The lookups resource is used to view standard lookup codes.
BusinessUnitVA
List of values indicating business unit that's selling the product.
CompetitiveAssetVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DYES_NO
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.
CountriesLOV
Parameters:
  • finder: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The list of values indicating the country.
CoverageRenewalStatusVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_ASSET_RENEWAL_STATUS
The list of values indicating the status of the renewed coverage of asset.
CoverageStateVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_ASSET_COVERAGE_STATE
The list of values indicating the coverage state of asset.
CurrentLocationContextVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DORA_CSE_CURRENT_LOC_CONTEXT
The list of values indicating the current location context in asset resource.
CustomerTypeLookup
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_RECORD_TYPE
List of values indicating customer party type.
ManufacturerVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{Manufacturer}%2CBindLookupType%3DORA_ZCM_ASSET_MANUFACTURER
The lookups resource is used to view standard lookup codes.
ModelVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{Model}%2CBindLookupType%3DORA_ZCM_ASSET_MODEL
The lookups resource is used to view standard lookup codes.
ProductGroupVA
Parameters:
  • finder: ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DZCM
Name for Product Group detail base public view object.
ProductTypeLookupVOVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_PROD_TYPE
The lookups resource is used to view standard lookup codes.
ProductVA
Parameters:
  • finder: ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DZCM
The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.
RatedCurrenciesVOVA
The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
SalesProductTypeVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DQSC_SALES_PRODUCT_TYPE
List of values indicating type of the product being sold such as goods or subscriptions.
SearchFilters
Parameters:
  • finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DZCA_ACCT_SRCH_RECORD_SET
The lookups resource is used to view standard lookup codes.
SourceObjectVA
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_ASSET_SOURCE_OBJECT
The list of values indicating the source of the asset data, such as Subscription.
Statuses
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ASSET_STATUS%2CBindLookupCode%3D{StatusCode}
The lookups resource is used to view standard lookup codes.
SubscriptionStatusCodeVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DORA_OSS_STATUS
List of values indicating status of the subscription.
VersionVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{Version}%2CBindLookupType%3DORA_ZCM_ASSET_VERSION
The lookups resource is used to view standard lookup codes.
YearVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{Year}%2CBindLookupType%3DORA_ZCM_ASSET_YEAR
The lookups resource is used to view standard lookup codes.
assetActivities
Parameters:
  • AssetId: $request.path.AssetId
The asset activities resource is used to view the activities of the asset. This is used to capture task and appointment information.
assetContacts
Parameters:
  • AssetId: $request.path.AssetId
The asset contacts resource is used to view, create, update, and delete the contacts associated with an asset.
assetLeads
Parameters:
  • AssetId: $request.path.AssetId
The asset leads resource is used to view an asset lead. A lead is a transaction record created when a party has expressed an interest in a product or service. It represents a selling opportunity.
assetOpportunities
Parameters:
  • AssetId: $request.path.AssetId
The asset opportunities resource is used to view the opportunities of an asset. An opportunity is used by a sales organization to track information about a potential sale such as the sales account, key contacts, product interests, and potential revenues.
assetResources
Parameters:
  • AssetId: $request.path.AssetId
Asset resources is used to view, create, update, and delete the team members associated with an asset.
assetServiceRequests
Parameters:
  • AssetId: $request.path.AssetId
The asset service requests resource is used to view the service requests related to an asset. These are header level information about a request from a customer for service from the time the customer makes the request until the request is resolved. For example, if a customer has an issue with their laptop battery draining too fast, the details of the customer and the issue they are facing is stored in the service request header.
attachments
Parameters:
  • AssetId: $request.path.AssetId
The attachments resource is used to view, create, update, and delete attachments of an asset. An attachment includes additional information about an asset.
smartActions
Parameters:
  • AssetId: $request.path.AssetId
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.
Back to Top

Examples

The following example shows how to get an asset by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/assets/788878612

Example of Response Body

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

{
      "AssetId": 788878612,
      "AssetNumber": "788878612",
      "AssetOrigSystem": null,
      "AssetOrigSystemReference": null,
      "BatchId": null,
      "AssetAmount": 0,
      "CreatedBy": "1",
      "CreationDate": "2010-07-23T14:16:45+00:00",
      "CustomerId": 999997550174807,
      "EndDate": null,
      "InstallDate": null,
      "InterfaceRowId": null,
      "InventoryItemId": 999997500683393,
      "InventoryOrgId": 204,
      "LastUpdateDate": "2010-07-23T14:16:45+00:00",
      "LastUpdateLogin": "-1",
      "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
      "PurchaseDate": null,
      "Quantity": 1,
      "StartDate": "2005-06-05",
      "StatusCode": "ACTIVE",
      "CrmConvRate": "Corporate",
      "AssetTag": null,
      "SerialNumber": null,
      "EnteredCurrencyCode": "USD",
      "DeleteFlag": null,
      "AttributeCategory": null,
      "CorpCurrencyCode": null,
      "CurcyConvRateType": null,
      "AssetName": null,
      "AssetDescription": null,
      "UOMCode": null,
      "ProdGroupId": null,
      "Description": "Sentinel Power 750VR-200 Server",
      "OrganizationId": 204,
      "ProdGroupName": null,
      "Product": "Sentinel Power 750VR-200 Server",
      "CompetitiveAsset": "N",
      "PrContactPartyId": null,
      "ResourceOwnerId": null,
      "Manufacturer": null,
      "Model": null,
      "Version": null,
      "Year": null,
      "AssetGroup": null,
      "links": [[
        .....
      ]
    }
Back to Top