Jump to

• Request
• Response
• Examples

Get an asset

get

/services/rest/connect/v1.4/assets/{id}

Request

Path Parameters

• id: integer
  The unique identifier of the asset.

Back to Top

Response

Default Response

Body ()

Root Schema : assets

Type: object

The product or service associated with an organization's customers.

Show Source

• contact(optional): [ "object", "null" ]
  The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
• createdTime(optional): string
  The date and time when the asset was created. This attribute is read-only.
• description(optional): [ "string", "null" ]
  Maximum Length: 1333

  The description of the asset.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the asset.
• installedDate(optional): [ "string", "null" ]
  The date when the asset was installed.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the asset.
• name(optional): string
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The name of the asset used as the lookupName for the asset object.
• organization(optional): [ "object", "null" ]
  The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
• price(optional): object assets-price
  The monetary value that consists of currency, exchange rate, and value.
• product(optional): [ "object", "null" ]
  The items or services sold by an organization. Sales products are available to customers through quotes and promotions. It is the reference to a resource in 'salesProducts' collection. Only ID or lookupName can be provided to specify the resource.
• purchasedDate(optional): [ "string", "null" ]
  The date when the asset was purchased.
• retiredDate(optional): [ "string", "null" ]
  The date when the asset was retired.
• serialNumber(optional): [ "string", "null" ]
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The serial number of the asset.
• sLAInstances(optional): object assets-sLAInstances
  The instance of a Service Level Agreement (SLA). An instance is created when a SLA is associated with a contact or organization.
• statusWithType(optional): object assets-statusWithType
  The current status and associated status type of an asset.
• updatedTime(optional): string
  The date and time when the asset was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The product or service associated with an organization's customers.",
    "properties":{
        "description":{
            "type":[
                "string",
                "null"
            ],
            "description":"The description of the asset.",
            "maxLength":1333
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the asset was last updated. This attribute is read-only."
        },
        "product":{
            "type":[
                "object",
                "null"
            ],
            "description":"The items or services sold by an organization. Sales products are available to customers through quotes and promotions. It is the reference to a resource in 'salesProducts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The name of the asset used as the lookupName for the asset object.",
            "maxLength":80
        },
        "sLAInstances":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The SLA instances associated with the asset.",
            "$ref":"#/definitions/assets-sLAInstances"
        },
        "serialNumber":{
            "pattern":"^[^\n]*$",
            "type":[
                "string",
                "null"
            ],
            "description":"The serial number of the asset.",
            "maxLength":80
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the asset.",
            "maxLength":255
        },
        "price":{
            "type":[
                "object",
                "null"
            ],
            "description":"The currency, exchange rate, and value of the asset.",
            "$ref":"#/definitions/assets-price"
        },
        "contact":{
            "type":[
                "object",
                "null"
            ],
            "description":"The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "statusWithType":{
            "type":[
                "object",
                "null"
            ],
            "description":"The current status and the associated status type.",
            "$ref":"#/definitions/assets-statusWithType"
        },
        "purchasedDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the asset was purchased."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the asset was created. This attribute is read-only."
        },
        "organization":{
            "type":[
                "object",
                "null"
            ],
            "description":"The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "retiredDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the asset was retired."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "maximum":9.223372036854776E18
        },
        "installedDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the asset was installed."
        }
    }
}

Nested Schema : assets-price

Type: object

The monetary value that consists of currency, exchange rate, and value.

Show Source

• currency(optional): object namedIDs-assets-price-currency
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• exchangeRate(optional): object namedIDs-assets-price-exchangeRate
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• value(optional): number
  Minimum Value: 0

  Maximum Value: 9.22337E15

  The value of the currency.

{
    "type":"object",
    "description":"The monetary value that consists of currency, exchange rate, and value.",
    "properties":{
        "currency":{
            "type":"object",
            "description":"The ID of the currency.",
            "$ref":"#/definitions/namedIDs-assets-price-currency"
        },
        "value":{
            "minimum":0,
            "type":"number",
            "description":"The value of the currency.",
            "maximum":9.22337E15
        },
        "exchangeRate":{
            "type":[
                "object",
                "null"
            ],
            "description":"The exchange rate in effect when the value was set. This is used to convert the value to other currencies.",
            "$ref":"#/definitions/namedIDs-assets-price-exchangeRate"
        }
    }
}

Nested Schema : assets-sLAInstances

Type: object

The instance of a Service Level Agreement (SLA). An instance is created when a SLA is associated with a contact or organization.

Show Source

• activeDate(optional): string
  The date when the instance became active.
• expireDate(optional): string
  The date when the instance is scheduled to expire.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the SLAInstance.
• nameOfSLA(optional): object namedIDs-assets-sLAInstances-nameOfSLA
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• remainingFromChat(optional): [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of remaining chat incidents.
• remainingFromCSR(optional): [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of remaining CSR incidents.
• remainingFromEmail(optional): [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of remaining email incidents.
• remainingFromWeb(optional): [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of remaining web self-service incidents.
• remainingTotal(optional): [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The total number of remaining incidents.
• sLASet(optional): integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The SLA set from which the instance was created.
• stateOfSLA(optional): object namedIDs-assets-sLAInstances-stateOfSLA
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The instance of a Service Level Agreement (SLA). An instance is created when a SLA is associated with a contact or organization.",
    "properties":{
        "activeDate":{
            "type":"string",
            "description":"The date when the instance became active."
        },
        "remainingFromCSR":{
            "minimum":0,
            "type":[
                "integer",
                "null"
            ],
            "description":"The number of remaining CSR incidents.",
            "maximum":2147483647
        },
        "expireDate":{
            "type":"string",
            "description":"The date when the instance is scheduled to expire."
        },
        "remainingFromEmail":{
            "minimum":0,
            "type":[
                "integer",
                "null"
            ],
            "description":"The number of remaining email incidents.",
            "maximum":2147483647
        },
        "sLASet":{
            "minimum":1,
            "type":"integer",
            "description":"The SLA set from which the instance was created.",
            "maximum":2147483647
        },
        "nameOfSLA":{
            "type":[
                "object",
                "null"
            ],
            "description":"The SLA from which the instance was created.",
            "$ref":"#/definitions/namedIDs-assets-sLAInstances-nameOfSLA"
        },
        "remainingTotal":{
            "minimum":0,
            "type":[
                "integer",
                "null"
            ],
            "description":"The total number of remaining incidents.",
            "maximum":2147483647
        },
        "remainingFromWeb":{
            "minimum":0,
            "type":[
                "integer",
                "null"
            ],
            "description":"The number of remaining web self-service incidents.",
            "maximum":2147483647
        },
        "remainingFromChat":{
            "minimum":0,
            "type":[
                "integer",
                "null"
            ],
            "description":"The number of remaining chat incidents.",
            "maximum":2147483647
        },
        "stateOfSLA":{
            "type":"object",
            "description":"The current state of the SLA. The supported values are Inactive, Active, Expired, or Disabled.",
            "$ref":"#/definitions/namedIDs-assets-sLAInstances-stateOfSLA"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the SLAInstance.",
            "maximum":9.223372036854776E18
        }
    }
}

Nested Schema : assets-statusWithType

Type: object

The current status and associated status type of an asset.

Show Source

• status(optional): object namedIDs-assets-statusWithType-status
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• statusType(optional): object namedIDs-assets-statusWithType-statusType
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The current status and associated status type of an asset.",
    "properties":{
        "status":{
            "type":"object",
            "description":"The current status.",
            "$ref":"#/definitions/namedIDs-assets-statusWithType-status"
        },
        "statusType":{
            "type":"object",
            "description":"The associated status type. This attribute is read-only.",
            "$ref":"#/definitions/namedIDs-assets-statusWithType-statusType"
        }
    }
}

Nested Schema : namedIDs-assets-price-currency

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-assets-price-exchangeRate

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-assets-sLAInstances-nameOfSLA

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-assets-sLAInstances-stateOfSLA

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-assets-statusWithType-status

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-assets-statusWithType-statusType

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to retrieve data for an asset object:

https://your_site_interface/services/rest/connect/version/assets/asset_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/assets/1

Response body example

{
  "id": 1,
  "lookupName": "Blizzard",
  "contact": null,
  "customFields": {},
  "description": "9-HP, 26-inch snowthrower",
  "installedDate": null,
  "name": "Blizzard",
  "organization": null,
  "price": {
    "currency": {
      "id": 1,
      "lookupName": "USD"
    },
    "exchangeRate": null,
    "value": 750
  },
  "product": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/salesProducts/4"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/salesProducts",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "purchasedDate": "2016-02-12",
  "retiredDate": null,
  "serialNumber": "SN0001",
  "sLAInstances": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/assets/1/sLAInstances"
      }
    ]
  },
  "statusWithType": null,
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/assets/1"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/assets/1"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/assets",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top