Create an asset
post
/services/rest/connect/v1.4/assets
Request
The product or service associated with an organization's customers.
Root Schema : assets
Type:
object
The product or service associated with an organization's customers.
Show Source
-
contact:
[
"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:
string
The date and time when the asset was created. This attribute is read-only.
-
description:
[
"string",
"null"
]
Maximum Length:
1333
The description of the asset. -
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the asset. -
installedDate:
[
"string",
"null"
]
The date when the asset was installed.
-
lookupName:
string
Maximum Length:
255
The name used to look up the asset. -
name:
string
Maximum Length:
80
Pattern:^[^ ]*$
The name of the asset used as the lookupName for the asset object. -
organization:
[
"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:
object assets-price
The monetary value that consists of currency, exchange rate, and value.
-
product:
[
"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:
[
"string",
"null"
]
The date when the asset was purchased.
-
retiredDate:
[
"string",
"null"
]
The date when the asset was retired.
-
serialNumber:
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The serial number of the asset. -
sLAInstances:
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:
object assets-statusWithType
The current status and associated status type of an asset.
-
updatedTime:
string
The date and time when the asset was last updated. This attribute is read-only.
Nested Schema : assets-price
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency:
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:
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:
number
Minimum Value:
0
Maximum Value:9223370000000000
The value of the currency.
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:
string
The date when the instance became active.
-
expireDate:
string
The date when the instance is scheduled to expire.
-
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the SLAInstance. -
nameOfSLA:
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:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining chat incidents. -
remainingFromCSR:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining CSR incidents. -
remainingFromEmail:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining email incidents. -
remainingFromWeb:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining web self-service incidents. -
remainingTotal:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The total number of remaining incidents. -
sLASet:
integer
Minimum Value:
1
Maximum Value:2147483647
The SLA set from which the instance was created. -
stateOfSLA:
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.
Nested Schema : assets-statusWithType
Type:
object
The current status and associated status type of an asset.
Show Source
-
status:
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:
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.
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
Response
Default Response
Root Schema : assets
Type:
object
The product or service associated with an organization's customers.
Show Source
-
contact:
[
"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:
string
The date and time when the asset was created. This attribute is read-only.
-
description:
[
"string",
"null"
]
Maximum Length:
1333
The description of the asset. -
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the asset. -
installedDate:
[
"string",
"null"
]
The date when the asset was installed.
-
lookupName:
string
Maximum Length:
255
The name used to look up the asset. -
name:
string
Maximum Length:
80
Pattern:^[^ ]*$
The name of the asset used as the lookupName for the asset object. -
organization:
[
"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:
object assets-price
The monetary value that consists of currency, exchange rate, and value.
-
product:
[
"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:
[
"string",
"null"
]
The date when the asset was purchased.
-
retiredDate:
[
"string",
"null"
]
The date when the asset was retired.
-
serialNumber:
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The serial number of the asset. -
sLAInstances:
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:
object assets-statusWithType
The current status and associated status type of an asset.
-
updatedTime:
string
The date and time when the asset was last updated. This attribute is read-only.
Nested Schema : assets-price
Type:
object
The monetary value that consists of currency, exchange rate, and value.
Show Source
-
currency:
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:
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:
number
Minimum Value:
0
Maximum Value:9223370000000000
The value of the currency.
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:
string
The date when the instance became active.
-
expireDate:
string
The date when the instance is scheduled to expire.
-
id:
integer
Minimum Value:
1
Maximum Value:9223372036854776000
The unique identifier of the SLAInstance. -
nameOfSLA:
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:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining chat incidents. -
remainingFromCSR:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining CSR incidents. -
remainingFromEmail:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining email incidents. -
remainingFromWeb:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of remaining web self-service incidents. -
remainingTotal:
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The total number of remaining incidents. -
sLASet:
integer
Minimum Value:
1
Maximum Value:2147483647
The SLA set from which the instance was created. -
stateOfSLA:
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.
Nested Schema : assets-statusWithType
Type:
object
The current status and associated status type of an asset.
Show Source
-
status:
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:
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.
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
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:
integer
Minimum Value:
0
ID value -
lookupName:
string
Maximum Length:
255
Name used to lookup this object
Examples
Use POST with the following syntax to create a new asset object:
https://your_site_interface/services/rest/connect/version/assets
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/assets
Request body example
{
"name": "Blizzard",
"product": [
{
"lookupName": "Blizzard"
}
],
"serialNumber": "SN0002"
}
Note:
Thename
and product ID
or LookupName
fields are required for assets.
Response body example
{
"id": 3,
"lookupName": "Blizzard",
"contact": null,
"customFields": {},
"description": null,
"installedDate": null,
"name": "Blizzard",
"organization": null,
"price": {
"currency": null,
"exchangeRate": null
},
"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": null,
"retiredDate": null,
"serialNumber": "SN0002",
"sLAInstances": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/assets/3/sLAInstances"
}
]
},
"statusWithType": null,
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/assets/3"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/assets/3"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/assets",
"mediaType": "application/schema+json"
}
]
}