Get all assets
get
/crmRestApi/resources/11.13.18.05/assets
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- AssetIdRowFinder
Finder Variables:- AssetId
- ByAccountHierarchy :Find the assets of accounts in hierarchy to the current account.
Finder Variables:- PartyId :The unique identifier of the party used to find the account by hierarchy.
- PartyIdAttribute :The unique identifier attribute name of the party used to find the account by hierarchy.
- ForDuplicateAccounts :Find the assets of duplicate accounts related to the current account.
Finder Variables:- PartyId :The unique identifier of the party used to find the duplicate accounts.
- PartyIdAttribute :The unique identifier attribute name of the party.
- ForRollup :Finds the assets associated with the rollups.
Finder Variables:- AttributeName :The rollup attribute name to find a rollups.
- RollupId :The unique identifier of a rollup used to find the rollup.
- SourceObject :The source object code used to find the rollup.
- SourceObjectId :The source object identifier of the party associated with the rollup.
- IBAssetIdRowFinder
Finder Variables:- IBAssetId
- PrimaryKey
Finder Variables:- AssetId
- AssetIdRowFinder
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AddressId; integer; The unique identifier of the address of the asset.
- AddressLine1; string; First line of address.
- AddressLine2; string; Second line of address.
- AddressLine3; string; Third line of address.
- AddressLine4; string; Fourth line of address.
- AddressName; string; Address name of the asset.
- AddressNumber; string; Alternate unique identifier for the address.
- AnnualRecurringRevenue; number; Annual Recurring Revenue from the Asset
- AssetAmount; number; The cost amount of the asset in the transaction currency.
- AssetId; integer; The unique identifier of the asset.
- AssetName; string; The name of the asset.
- AssetNumber; string; The alternate identifier of the asset.
- AssetOwnerCustomerId; integer; The unique identifier of the customer that owns the asset.
- AssetOwnerCustomerName; string; The name of the customer that owns the asset.
- AssetOwnerCustomerNumber; string; The number assigned to the customer that owns the asset
- BOMComponentFlag; boolean; The indicator used to show if a part is a component in a bill-of-materials.
- Building; string; Specific building name or number at a given address.
- City; string; The city element of address.
- CompetitiveAsset; string; Indicates whether the product associated is a competitor asset.
- Country; string; Country code of the address.
- County; string; County element of address.
- CurrentLocationContext; string; The current location type of an asset or genealogy instance.
- CustomerId; integer; The unique identifier of the existing customer party.
- CustomerPartyNumber; string; The unique identifier of the account associated with the asset.
- DeleteFlag; boolean; Delete Flag for soft deletes, Y for Yes and NULL or N for No. Indicates whether the asset is to be deleted. If the value is Y, then the asset has to be deleted. The default value is N.
- Description; string; The brief description of the asset item.
- EndDate; string; The date when the asset ends.
- FloorNumber; string; The specific floor number at a given address or in a particular building when the building number is provided.
- IBAssetId; integer; This attribute is deprecated. The unique identifier of the Install Base asset record.
- IBAssetSyncedVersionNumber; integer; The last synced version number of the Install Base Asset.
- InstallDate; string; The date the asset was installed.
- InterfaceRowId; integer; This attribute is deprecated. The unique identifier of the interface table row.
- InventoryItemId; integer; The unique identifier for the sales catalog product.
- InventoryOrgId; integer; The unique identifier of the inventory organization.
- ItemNumber; string; The alternate unique identifier of the item associated with the asset.
- LastUpdateDate; string; The date and time when the asset was last updated.
- Latitude; number; The latitude of the address.
- LocationId; integer; The unique location key for the asset.
- Longitude; number; The longitude of the address.
- OrderFulfillLineKey; string; The key assigned during fulfillment of an order line.
- OrderFulfillLineNumber; string; The number assigned to the fulfillment of a line within an order.
- OrderKey; string; The key assigned to an order.
- OrderLineKey; string; The key assigned to a line within an order.
- OrderLineNumber; string; The number assigned to a line within an order.
- OrderNumber; string; The number assigned to an order.
- OrderSourceSystem; string; The system that's the source of the order.
- OrderedDate; string; The date when the asset was ordered.
- OrganizationId; integer; The unique identifier of the asset's resource organization.
- PartyType; string; The type of the asset owner, such as a person, an organization, or a group.
- PartyUniqueName; string; The unique name of the asset owner.
- PostalCode; string; The postal code as defined by the formal countrywide postal system.
- PrContactPartyId; integer; The unique identifier of a valid resource who manages the asset.
- PrContactPartyNumber; string; The unique identifier of the account or contact associated with the asset.
- ProdGroupId; integer; The unique identifier of the product group in the sales catalog.
- ProdGroupName; string; The name of the product group associated with the asset.
- ProdGroupReferenceNumber; string; The unique identifier for the product group associated with the asset.
- Product; string; The name of the product associated with the asset.
- Province; string; The province element of address.
- PurchaseDate; string; The date the asset was purchased.
- Quantity; number; The quantity purchased.
- QuoteAssetKey; string; The key used to identify an asset when creating a quote.
- QuoteKey; string; The key used to identify the quote.
- QuoteLineKey; string; The key used to identify the line within a quote.
- QuoteLineNumber; string; The number used to identify the line within a quote.
- QuoteNumber; string; The number used to identify the quote.
- QuoteParentAssetKey; string; The key associated with the parent asset in a quote.
- QuoteRootAssetKey; string; The key associated with the root asset within a quote.
- QuoteSourceSystem; string; The system the quote is sourced from.
- ResourceOwnerId; integer; The unique identifier of a valid employee resource who manages the asset.
- ResourceOwnerPartyNumber; string; The unique identifier of the resource owner associated with the asset.
- SalesProductType; string; The type of the product being sold such as goods or subscriptions.
- SearchFilter; string; The filter associated with the search on an asset.
- SerialNumber; string; The serial number of the asset.
- ShipToPartyId; integer; The ship-to party of the asset.
- ShipToPartyName; string; Represents the ship-to party name identifier of the asset.
- ShipToPartyNumber; string; The number representing the ship-to party of the asset.
- SoldByBusinessUnitId; integer; The identifier of the business unit.
- SourceAssetNumber; string; The number assigned to the source of the asset.
- SourceObjectCode; string; The object code used to identify the source.
- StartDate; string; The date when the asset starts.
- State; string; The state element of address.
- StatusCode; string; The lookup code that represents the asset status. The lookup type is ZCA_ASSET_STATUS which has the following values Active, and expired out of the box.
- SubscriptionNumber; string; The number used to identify the subscription.
- SubscriptionStatusCode; string; The code used to identify the status of the subscription.
- TotalAssetAmount; number; The asset amount obtained by the asset quantity times the unit price of an asset
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-item-response
Type:
Show Source
object
-
AccountNameTransientForLOV: string
Title:
Asset Owner
The name of the account for use in the LOV. -
AccountSourceSystem: string
Title:
Account Source System
The system from where the account associated with the asset is sourced. -
AccountSourceSystemReference: string
Title:
Account Source System Reference
The reference system from where the account associated with the asset is sourced. -
AddressId: integer
(int64)
Title:
Address Id
The unique identifier of the address of the asset. -
AddressLine1: string
Title:
Address Line 1
Read Only:true
Maximum Length:240
First line of address. -
AddressLine2: string
Title:
Address Line 2
Read Only:true
Maximum Length:240
Second line of address. -
AddressLine3: string
Title:
Address Line 3
Read Only:true
Maximum Length:240
Third line of address. -
AddressLine4: string
Title:
Address Line 4
Read Only:true
Maximum Length:240
Fourth line of address. -
AddressName: string
Title:
Address Name
Read Only:true
Maximum Length:240
Address name of the asset. -
AddressNumber: string
Title:
Site Number
Alternate unique identifier for the address. -
AnnualRecurringRevenue: number
Title:
Annual Recurring Revenue
Read Only:true
Annual Recurring Revenue from the Asset -
assetActivities: array
Asset Activities
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. -
AssetAmount: number
Title:
Purchase Unit Price
The cost amount of the asset in the transaction currency. -
assetContacts: array
Asset Contacts
Title:
Asset Contacts
The asset contacts resource is used to view, create, update, and delete the contacts associated with an asset. -
AssetDescription: string
Title:
Description
Maximum Length:2000
The description of the asset. -
AssetGroup: string
Title:
Group
Maximum Length:30
The asset product name defined by the administrator. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of the asset. -
assetLeads: array
Asset Leads
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. -
AssetName: string
Title:
Asset Name
Maximum Length:300
The name of the asset. -
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The alternate identifier of the asset. -
assetOpportunities: array
Asset Opportunities
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. -
AssetOrigSystem: string
Title:
Asset Origin System
Maximum Length:30
A source system code that identifies the original source system of the asset. -
AssetOrigSystemReference: string
Title:
Asset Origin System Reference
Maximum Length:255
A source system reference that identifies the unique identifier of the asset in the user's legacy or external system. -
AssetOwnerCustomerId: integer
(int64)
Title:
Asset Owner
Read Only:true
The unique identifier of the customer that owns the asset. -
AssetOwnerCustomerName: string
Title:
Customer
Read Only:true
Maximum Length:360
The name of the customer that owns the asset. -
AssetOwnerCustomerNumber: string
Title:
Customer Number
Read Only:true
Maximum Length:30
The number assigned to the customer that owns the asset -
assetResources: array
Asset Resources
Title:
Asset Resources
Asset resources is used to view, create, update, and delete the team members associated with an asset. -
assetServiceRequests: array
Asset Service Requests
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. -
AssetTag: string
Title:
Asset Tag
Maximum Length:50
The tag number associated with the asset. -
attachments: array
Attachments
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. -
AttributeCategory: string
Maximum Length:
30
This attribute is deprecated. The standard column used in Fusion tables. -
BatchId: integer
(int64)
Title:
Batch Identifier
This attribute is deprecated. The unique identifier of the batch associated with the importing process. This attribute is deprecated. -
BOMComponentFlag: boolean
Title:
BOM Component
Read Only:true
Maximum Length:1
The indicator used to show if a part is a component in a bill-of-materials. -
Building: string
Title:
Building
Read Only:true
Maximum Length:240
Specific building name or number at a given address. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city element of address. -
CompetitiveAsset: string
Title:
Competitor Asset
Maximum Length:1
Default Value:N
Indicates whether the product associated is a competitor asset. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
Country code of the address. -
County: string
Title:
County
Read Only:true
Maximum Length:60
County element of address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created or imported the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the asset was created. -
CrmConvRate: string
Title:
Conversion Rate
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrentLocationContext: string
Title:
Current Location Context
Read Only:true
Maximum Length:30
The current location type of an asset or genealogy instance. -
CustomerId: integer
(int64)
Title:
Asset Owner Party ID
The unique identifier of the existing customer party. -
CustomerPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The unique identifier of the account associated with the asset. -
DeleteFlag: boolean
Title:
Deleted Asset Indicator
Maximum Length:1
Delete Flag for soft deletes, Y for Yes and NULL or N for No. Indicates whether the asset is to be deleted. If the value is Y, then the asset has to be deleted. The default value is N. -
DelFlag: boolean
Title:
Delete Access
Read Only:true
This flag controls if the user has access to Delete the record -
Description: string
Title:
Product Item
Maximum Length:240
The brief description of the asset item. -
EndDate: string
(date)
Title:
End Date
The date when the asset ends. -
EnteredCurrencyCode: string
Title:
Currency
Maximum Length:20
The code that represents the currency for the asset amounts. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
ExchangeRate: number
Title:
Exchange Rate
Read Only:true
The currency exchange rate. -
FloorNumber: string
Title:
Floor
Read Only:true
Maximum Length:40
The specific floor number at a given address or in a particular building when the building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the address. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset ID
This attribute is deprecated. The unique identifier of the Install Base asset record. -
IBAssetSyncedVersionNumber: integer
(int32)
Title:
IB Asset Synchronized Version Number
The last synced version number of the Install Base Asset. -
InstallDate: string
(date)
Title:
Install Date
The date the asset was installed. -
InterfaceRowId: integer
(int64)
This attribute is deprecated. The unique identifier of the interface table row.
-
InventoryItemId: integer
(int64)
Title:
Product ID
The unique identifier for the sales catalog product. -
InventoryOrgId: integer
(int64)
Title:
Product Org ID
The unique identifier of the inventory organization. -
ItemNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The alternate unique identifier of the item associated with the asset. -
ItemSourceSystem: string
Title:
Item Source System
The system from where the product is sourced. -
ItemSourceSystemReference: string
Title:
Item Source System Reference
The reference system from where the product is sourced. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the asset was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the asset. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The user who last updated the record in the interface table or submitted the import process. -
Latitude: number
Title:
Latitude
Read Only:true
The latitude of the address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Title:
Location Id
Read Only:true
The unique location key for the asset. -
Longitude: number
Title:
Longitude
Read Only:true
The longitude of the address. -
Manufacturer: string
Title:
Manufacturer
Maximum Length:30
The organization that manufactures the product. -
Model: string
Title:
Model
Maximum Length:30
The short name of the asset product details. -
OrderedDate: string
(date)
Title:
Ordered Date
The date when the asset was ordered. -
OrderFulfillLineKey: string
Title:
Order Fulfillment Line Key
Maximum Length:120
The key assigned during fulfillment of an order line. -
OrderFulfillLineNumber: string
Title:
Order Fulfillment Line Number
Maximum Length:120
The number assigned to the fulfillment of a line within an order. -
OrderKey: string
Title:
Order Key
Maximum Length:120
The key assigned to an order. -
OrderLineKey: string
Title:
Order Line Key
Maximum Length:120
The key assigned to a line within an order. -
OrderLineNumber: string
Title:
Order Line Number
Maximum Length:120
The number assigned to a line within an order. -
OrderNumber: string
Title:
Order Number
Maximum Length:120
The number assigned to an order. -
OrderSourceSystem: string
Title:
Order Source
Maximum Length:30
The system that's the source of the order. -
OrganizationId: integer
(int64)
Title:
Organization
Read Only:true
The unique identifier of the asset's resource organization. -
PartyType: string
Title:
Customer Type
Read Only:true
Maximum Length:30
The type of the asset owner, such as a person, an organization, or a group. -
PartyUniqueName: string
Title:
Asset Owner
Read Only:true
Maximum Length:900
The unique name of the asset owner. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PrContactPartyId: integer
(int64)
Title:
Primary Contact Party ID
The unique identifier of a valid resource who manages the asset. -
PrContactPartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The unique identifier of the account or contact associated with the asset. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group in the sales catalog. -
ProdGroupName: string
Title:
Product Group
Maximum Length:250
The name of the product group associated with the asset. -
ProdGroupReferenceNumber: string
Title:
Product Group Number
Maximum Length:50
The unique identifier for the product group associated with the asset. -
Product: string
Title:
Product
Read Only:true
Maximum Length:250
The name of the product associated with the asset. -
ProductType: string
Title:
Product Type
The type of the product, such as an item or a product group. -
Province: string
Title:
Province
Read Only:true
Maximum Length:60
The province element of address. -
PurchaseDate: string
(date)
Title:
Purchase Date
The date the asset was purchased. -
Quantity: number
Title:
Quantity
The quantity purchased. -
QuoteAssetKey: string
Title:
Quote Asset Key
Maximum Length:120
The key used to identify an asset when creating a quote. -
QuoteKey: string
Title:
Quote Key
Maximum Length:120
The key used to identify the quote. -
QuoteLineKey: string
Title:
Quote Line Key
Maximum Length:120
The key used to identify the line within a quote. -
QuoteLineNumber: string
Title:
Quote Line Number
Maximum Length:120
The number used to identify the line within a quote. -
QuoteNumber: string
Title:
Quote Number
Maximum Length:120
The number used to identify the quote. -
QuoteParentAssetKey: string
Title:
Quote Parent Asset Key
Maximum Length:120
The key associated with the parent asset in a quote. -
QuoteRootAssetKey: string
Title:
Quote Root Asset Key
Maximum Length:120
The key associated with the root asset within a quote. -
QuoteSourceSystem: string
Title:
Quote Source System
Maximum Length:30
The system the quote is sourced from. -
ResourceOwnerId: integer
(int64)
Title:
Resource Owner ID
The unique identifier of a valid employee resource who manages the asset. -
ResourceOwnerPartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The unique identifier of the resource owner associated with the asset. -
SalesProductType: string
Title:
Sales Product Type
Read Only:true
Maximum Length:30
The type of the product being sold such as goods or subscriptions. -
SearchFilter: string
Title:
Record Set
Read Only:true
Maximum Length:30
The filter associated with the search on an asset. -
SerialNumber: string
Title:
Serial Number
Maximum Length:100
The serial number of the asset. -
ShipToPartyId: integer
(int64)
Title:
Ship-To Party Id
The ship-to party of the asset. -
ShipToPartyName: string
Title:
Ship-to Party Name
Read Only:true
Maximum Length:360
Represents the ship-to party name identifier of the asset. -
ShipToPartyNumber: string
Title:
Ship-to Party Number
Read Only:true
Maximum Length:30
The number representing the ship-to party of the asset. -
smartActions: array
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. -
SoldByBusinessUnitId: integer
(int64)
Title:
Business Unit
The identifier of the business unit. -
SoldByBusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit that the product is sold by. -
SourceAssetNumber: string
Title:
Asset Source Number
Read Only:true
Maximum Length:120
The number assigned to the source of the asset. -
SourceObjectCode: string
Title:
Source Object Code
Read Only:true
Maximum Length:30
The object code used to identify the source. -
StartDate: string
(date)
Title:
Start Date
The date when the asset starts. -
State: string
Title:
State
Read Only:true
Maximum Length:60
The state element of address. -
StatusCode: string
Title:
Status
Maximum Length:50
Default Value:ACTIVE
The lookup code that represents the asset status. The lookup type is ZCA_ASSET_STATUS which has the following values Active, and expired out of the box. -
SubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The number used to identify the subscription. -
SubscriptionStatusCode: string
Title:
Subscription Status
Read Only:true
Maximum Length:30
The code used to identify the status of the subscription. -
TotalAssetAmount: number
Title:
Total Asset Amount
Read Only:true
The asset amount obtained by the asset quantity times the unit price of an asset -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure for the asset. -
UpdateFlag: boolean
Title:
Update Access
Read Only:true
This flag controls if the user has access to update the record -
Version: string
Title:
Version
Maximum Length:30
Specifies the asset product version number. -
Year: string
Title:
Year
Maximum Length:30
Specifies the year in which the asset product instance was manufactured.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
AccountAddress: string
Title:
Account Address
Read Only:true
The address associated with the account. -
AccountId: integer
(int64)
Title:
Account ID
Party Id of the activity account (Customer - org/person, or Partner etc.). -
AccountIdAttr: integer
The attribute for the account identifier (Not for public usage).
-
AccountName: string
Title:
Account
The name of account associated to activity. -
AccountNameOsn: string
Title:
Social Account Name
The account name as displayed in Oracle Social Network. -
AccountNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
Account Number of account associated with the activity. -
AccountPhoneNumber: string
Title:
Account Phone Number
Read Only:true
The phone number associated with the account. -
AccountStatus: string
Read Only:
true
Maximum Length:1
The status of the account. -
AccountType: string
Read Only:
true
Maximum Length:30
The type of the account. -
ActivityCreatedBy: string
Title:
Activity Created By
Read Only:true
Maximum Length:64
Original Activity Created By -
ActivityCreationDate: string
(date-time)
Title:
Activity Creation Date
Read Only:true
Original Activity Creation Date -
ActivityDescription: string
(byte)
Title:
Description
A text field for capturing some descriptive information about the activity. -
ActivityDirection: string
Read Only:
true
The outcome of the activity. -
ActivityEndDate: string
(date-time)
Title:
End Date
The date and time when an appointment ends or the completion time of a task. -
ActivityFilter: string
Read Only:
true
An attribute to add additional activity filter (Not for public usage). -
ActivityFunctionCode: string
Title:
Activity
Maximum Length:30
The activity function code that is task vs appointment. For system use only. -
ActivityFunctionCodeTrans: string
Title:
Activity
Maximum Length:255
The activity function code. -
ActivityId: integer
(int64)
Title:
Activity ID
System generated non-nullable primary key of the table. -
ActivityLastUpdateLogin: string
Title:
Activity Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the activity. -
ActivityMtgMinutes: string
(byte)
Title:
Meeting Minutes
The meeting minutes of the activity. -
ActivityNumber: string
Title:
Activity Number
Maximum Length:64
System generated or can come from external system (user key). -
ActivityOutcome: string
Read Only:
true
The direction of the interaction. -
ActivityPartialDescription: string
Title:
Short Description
Maximum Length:4000
A column that stores the first 4000 characters of activity description. -
ActivityPriority: string
Title:
Priority
Indicates the priority of the activity (Not for public usage). -
ActivityStartDate: string
(date-time)
Title:
Start Date
The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task. -
ActivityStatus: string
Title:
Status
Read Only:true
The status of the activity. -
ActivitySubtypeCode: string
Title:
Subtype
Maximum Length:30
Displays a list of subtype values that are dependent on the value of the activity. -
ActivityTimezone: string
Represents the time zone that the activity needs to be created in, other than the default logged in user's time zone preference.
-
ActivityType: string
Title:
Activity Type
The type of the activity. -
ActivityTypeCode: string
Title:
Type
Maximum Length:30
The type or category of the activity. -
ActivityUpdateDate: string
(date-time)
Title:
Activity Updated Date
Read Only:true
The date when the activity was updated. -
ActivityUpdatedBy: string
Title:
Activity Updated By
Read Only:true
Maximum Length:64
The user who updated the activity. -
ActivityUserLastUpdateDate: string
(date-time)
Title:
Activity User Last Updated Date
Read Only:true
The date when the activity was last updated. -
AllDayFlag: boolean
Title:
All Day
Maximum Length:1
Default Value:false
Designates that an appointment is the entire day. -
AppointmentStatus: string
Title:
Appointment Status
Maximum Length:30
Denotes the status of the appointment. -
ApptEndTime: string
(date-time)
Title:
End Time
The time when the activity ends. -
ApptStartTime: string
(date-time)
Title:
Start Time
The time when the activity starts. -
ArticleVersionId: string
Title:
Article Version ID
Maximum Length:64
Knowledge Article Version -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of the assessment to which the activity or the activity template is associated to. -
AssetId: integer
(int64)
Title:
Asset ID
Id of the Asset associated with the activity. -
AssetName: string
Title:
Asset
Name of the Asset associated with the activity -
AssetNumber: string
Title:
Asset Number
Asset Number. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
Asset Serial Number. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:ZMM_ACTY_ACTIVITIES
The name of the attachment entity. -
AutoLogSource: string
Title:
Source System
Maximum Length:30
For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity. -
BpId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the related business plan. -
BuOrgId: integer
(int64)
Title:
Business Unit
The unique identifier for the Business Unit. This attribute is obsolete. -
BusinessPlanName: string
Title:
Business Plan
The business plan name associated to the activity. -
BusinessPlanNumber: string
Title:
Business Plan Number
Business Plan Number of the business plan associated with the activity. -
CalendarAccess: boolean
The access rights to calendar (Not for public usage).
-
CalendarRecurType: string
The activity recurrence type.
-
CalendarSubject: string
The activity subject.
-
CalendarSubjectDay: string
The title of the calendar.
-
CalendarTimeType: string
Indicates all day appointment (Not for public usage).
-
CallReportCount: integer
(int32)
Title:
Call Report Count
Default Value:0
A count of the number of call reports. -
CallReportUpcomingYN: string
Indicates whether the appointment is upcoming.
-
CallReportYN: string
Indicates whether the activity has a call report.
-
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignName: string
Title:
Campaign
The name of campaign associated to the activity. -
CampaignNumber: string
Title:
Campaign Number
Campaign Number of the campaign associated with the activity. -
CaseId: integer
(int64)
Title:
Case ID
Case Id -
CaseNumber: string
Title:
Case Number
Case Number -
CaseTitle: string
Title:
Title
Read Only:true
Maximum Length:400
Case Title -
CheckedInBy: string
Title:
Checked-In By
Maximum Length:64
Specifies the name of the person who checks-in to a location. -
CheckedOutBy: string
Title:
Checked-Out By
Maximum Length:64
Specifies the name of the person who checks-out to a location. -
CheckinDate: string
(date-time)
Title:
Check-In Time
Stores the date and time when a user checks in to an Appointment. -
CheckinLatitude: number
Title:
Check-In Latitude
Stores the latitude of a location where a user checks in to an Appointment. -
CheckinLongitude: number
Title:
Check-In Longitude
Stores the longitude of a location where a user checks in to an Appointment. -
CheckoutDate: string
(date-time)
Title:
Check-Out Time
Stores the date and time when a user checks out of an Appointment. -
CheckoutLatitude: number
Title:
Check-Out Latitude
Stores the latitude of a location where a user checks out of an Appointment. -
CheckoutLongitude: number
Title:
Check-Out Longitude
Stores the longitude of a location where a user checks out of an Appointment. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the related claim. -
ClaimName: string
Title:
MDF Claim
The claim name associated to the activity. -
ClaimNumber: string
Title:
Claim Number
Claim Number of the claim associated with the activity. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. (Not for public usage). -
ContactIDAttr: integer
The contact identifier (Not for public usage).
-
ContactNumber: string
Title:
Contact Number
Read Only:true
Maximum Length:30
Contact Number of primary contact associated with the activity. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the asset. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Look -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The system attribute used to capture the user ID of the activity creator. This is defaulted by the system. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The system attribute to capture the date and time the activity was created. This is defaulted by the system. -
CurcyConvRateType: string
Title:
Currency Conversion Rate
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code. -
CurrentDateForCallReport: string
(date-time)
The current date for the call report.
-
CurrentDateForCallReportAttr: string
(date-time)
The attribute for the current date for the call report (Not for public usage).
-
CurrentSystemDtTransient: string
(date)
Read Only:
true
The current system date. -
CustomerAccountId: integer
(int64)
Title:
Customer Account ID
The unique identifier of customer account that the activity relates to. -
DealId: integer
(int64)
Title:
Deal ID
The unique identifier of the deal. -
DealNumber: string
Title:
Deal Registration
The deal number associated to the activity. -
DelegatorId: integer
(int64)
Title:
Delegator ID
The activity resource that delegated activity ownership to another resource. -
DelegatorName: string
Title:
Delegated By
The name of activity resource that delegated activity ownership to another resource. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the user has access to delete the record. -
DerivedAccountId: integer
The unique identifier of the derived account.
-
DirectionCode: string
Title:
Direction
Maximum Length:30
The code of the direction. Values are Inbound or Outbound. The default is null. -
DismissAssignee: string
Title:
Dismissed
Flag to dismiss Assignee. Valid values are Y and N. -
DismissFlag: boolean
Title:
Dismissed
Maximum Length:1
Indicates whether this activity is dismissed. -
DoNotCallFlag: boolean
Read Only:
true
Flag to indicate if primary Contact can be called. -
DueDate: string
(date)
Title:
Due Date
The date the task activity is due to be completed. -
Duration: number
Title:
Duration
The duration of an appointment or task. -
DynamicClaimLOVSwitcher: string
Read Only:
true
The unique identifier of the account. -
EmailSentDate: string
(date-time)
This field is used to capture the Activity Email Notification shared date for Outlook integration
-
EndDateForCallReport: string
(date-time)
The end date of the call report.
-
EndDateForCallReportAttr: string
(date-time)
The attribute for end date of the call report (Not for public usage).
-
EndDtRFAttr: string
(date-time)
The attribute for activity start date (Not for public usage).
-
ExternalContactEmail: string
Title:
Primary Email
Maximum Length:320
Indicates the email address of an external contact. -
ExternalContactName: string
Title:
External Contact Name
Maximum Length:360
Indicates the name of an external contact. -
ExternallyOwnedFlag: boolean
Title:
Externally Owned
Maximum Length:1
Default Value:false
Indicates that the activity is not created by an internal resource. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the related fund request. -
FundRequestName: string
Title:
MDF Request
The fund request name associated to the activity. -
FundRequestNumber: string
Title:
Fund Request Number
Fund Request Number of the fund request associated with the activity. -
IbAssetId: integer
(int64)
Title:
IB Asset ID
Id of the Installed Base Asset associated with the activity. -
IbAssetNumber: string
Title:
Installed Base Asset
Number of the Installed Base Asset associated with the activity. -
IbAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
Serial Number of the Installed Base Asset associated with the activity. -
InstNumDerivedFrom: string
Default Value:
Y
The attribute to identify recurrence mode (Not for public usage). -
IsClientService: string
Default Value:
Y
The obsolete attribute (Not for public usage). -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead. -
LeadIdAttr: integer
The attribute for the lead identifier (Not for public usage).
-
LeadName: string
Title:
Lead
The name of the lead. -
LeadNameOsn: string
Title:
Social Lead Name
The lead name as displayed in Oracle Social Network. -
LeadNumber: string
Title:
Lead Number
Lead Number of lead associated with the activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Location
Maximum Length:200
The location of the appointment. -
LocationId: integer
(int64)
Title:
Location ID
The location or address identifier of the activity account or primary contact. -
LoginUserRFAttr: integer
The attribute for activity login user (Not for public usage).
-
MdfRequestId: integer
The identifier for fund request.
-
MobileActivityCode: string
Title:
Mobile Activity Code
Maximum Length:50
The unique identifier of external mobile device. -
NotesLinkSourceCodeTransient: string
Read Only:
true
The note source object. -
ObjectiveId: integer
(int64)
Title:
Objective ID
The unique identifier of the related objective. -
OpportunityId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OpportunityIdAttr: integer
The attribute for the opportunity identifier (Not for public usage).
-
OpportunityName: string
Title:
Opportunity
The name of opportunity associated to the activity. -
OpportunityNameOsn: string
Title:
Social Opportunity Name
The opportunity name displayed in Oracle Social Network. -
OpportunityNumber: string
Title:
Opportunity Number
Opportunity Number of the opportunity Associated with the activity. -
OrchestrationId: integer
(int64)
Title:
Orchestration ID
The unique identifier to identify the orchestration process. -
OrchestrationStepId: integer
(int64)
Title:
Orchestration Step ID
The unique identifier to identify the orchestration step. -
OrigEntityCode: string
Maximum Length:
30
Default Value:ACTIVITY
The column to store the source of activity record during upgrade. -
OrigEntityNumber: string
Maximum Length:
64
The column to store the original user key of the object being upgraded to Activity. -
OsnActivityId: integer
(int64)
The unique activity identifier.
-
OtherPartyPhoneNumber: string
Title:
Other Party Phone Number
Maximum Length:40
For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called. -
OutcomeCode: string
Title:
Outcome
Maximum Length:30
The outcome of the activity. -
OutlookAutoSyncFlag: boolean
Title:
Microsoft Auto-Synchronization
Maximum Length:1
Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365 -
OutlookFlag: boolean
Title:
Outlook
Maximum Length:1
Default Value:false
Indicates whether created from Outlook and synced, "Y". -
OutlookGlobalId: string
Title:
Outlook Global ID
Maximum Length:1024
The unique identifier of an appointment created from Microsoft 365 -
OutlookIdentifier: string
Title:
Outlook Identifier
Maximum Length:1024
The unique identifier from Outlook Activity. -
OwnerAddress: string
Title:
Activity Owner Address
Read Only:true
The activity owner's address. -
OwnerEmailAddress: string
Title:
Activity Owner Email
Read Only:true
Maximum Length:320
The activity owner's email address. -
OwnerId: integer
(int64)
Title:
Owner ID
The primary resource on the activity. Supports resources only. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of primary resource of activity. -
OwnerNameOsn: string
Title:
Social Owner Name
The owner name displayed in Oracle Social Network. -
OwnerPhoneNumber: string
Title:
Activity Owner Phone Number
Read Only:true
The activity owner's phone number. -
ParentActivityId: integer
(int64)
Title:
Parent ID
The unique identifier of the parent activity. It is only applicable if the record is a follow up activity. -
ParentActivityIdAttr: string
The attribute for the parent activity identifier (Not for public usage).
-
PartialMtgMinutes: string
Title:
Short Meeting Minutes
Maximum Length:4000
A column that stores a truncated string of the meeting minutes. -
PartnerEnrollmentId: integer
(int64)
Title:
Enrollment ID
The unique identifier of the partner enrollment. -
PartnerEnrollmentNumber: string
Title:
Enrollment Number
The surrogate key for partner enrollment. -
PartnerPartyId: integer
(int64)
Title:
Partner Party ID
Party identifier of the partner organization. -
PartnerPartyName: string
Title:
Partner
Maximum Length:80
Party name of the partner organization. -
PartnerPartyNumber: string
Title:
Partner Number
Partner Party Number of partner associated with the activity. -
PartnerProgramId: integer
(int64)
Title:
Partner Program ID
The unique identifier of the partner program. -
PartnerProgramName: string
Title:
Program
The name of partner program associated to the activity. -
PartnerProgramNumber: string
Title:
Program Number
Partner Program Number of partner program associated with the activity. -
PartnerUsageFlag: boolean
Title:
Partner Usage
Maximum Length:1
Default Value:false
Flag to indicate that the Activity has been created for an Organization Account with usage as Partner. -
PercentageComplete: number
Title:
Percentage Complete
Default Value:0
Numeric Value 0-100 to reflect the percent complete status of the activity. Free form numeric. % value at end. -
PrimaryContactEmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email id of the primary contact. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the primary contact. -
PrimaryContactName: string
Title:
Primary Contact
The name of primary contact. -
PrimaryContactNameOsn: string
Title:
Social Primary Contact Name
The primary contact name displayed in Oracle Social Network. -
PrimaryFormattedAddress: string
Title:
Primary Contact Address
Read Only:true
Holds Address of the primary contact -
PrimaryFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the primary contact. -
PriorityCode: string
Title:
Priority
Maximum Length:30
The priority of the activity. Default to 2. Possible values: 1, 2, 3. -
PrivateFlag: boolean
Title:
Private
Maximum Length:1
Indicates whether the activity is private. -
RecordSet: string
Title:
Record Set
Maximum Length:255
The set of records to display in activity search. -
RecurDay: integer
(int64)
Title:
Day
Repeat on specified day of month (for monthly appointments). -
RecurEndDate: string
(date-time)
Title:
Ends
Ends on a specified date. -
RecurEveryOptionFlag: boolean
Title:
Recurrence Option
Maximum Length:1
Indicates whether the recurrence occurs for every day, month, year, etc. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it is everyday of the week, it is set to Y if it is weekdays only, it is set to N. -
RecurExceptionFlag: boolean
Title:
Recurrence Exception
Maximum Length:1
Indicates whether the appointment instance has been updated outside of recurring appointment series. -
RecurFrequency: number
Title:
Repeat
The frequency with which the recurring appointment series repeats. -
RecurFriFlag: boolean
Title:
Friday
Maximum Length:1
Repeats on Friday. -
RecurMonFlag: boolean
Title:
Monday
Maximum Length:1
Repeats on Monday. -
RecurMonth: string
Title:
Month
Maximum Length:30
Repeats on specified month (for yearly appointments). -
RecurNumberOfInstances: number
Title:
Number of Instances
Designates specific number of occurrences for the series to end after. -
RecurOrigInstDate: string
(date-time)
Title:
Original Instance Date
The original date of a recurring appointment instance. -
RecurPattern: string
Title:
Pattern
Maximum Length:30
Designates which week for appointment to recur (for monthly and yearly appointments). Possible values: First, Second, Third, Fourth, Last. -
RecurRecType: string
Title:
Recurrence Record Type
Maximum Length:1
Default Value:N
The recurring record type. Either "I" for instance or "S" for series or "N" for non-recurring. Do not populate it if Activity is of type Task. For internal use only. -
RecurSatFlag: boolean
Title:
Saturday
Maximum Length:1
Repeats on Saturday. -
RecurSeriesId: integer
(int64)
Title:
Recurrence Series ID
The unique identifier of the series that links instances of a series together. -
RecurSunFlag: boolean
Title:
Sunday
Maximum Length:1
Repeats on Sunday. -
RecurThuFlag: boolean
Title:
Thursday
Maximum Length:1
Repeats on Thursday. -
RecurTueFlag: boolean
Title:
Tuesday
Maximum Length:1
Repeats on Tuesday. -
RecurTypeCode: string
Title:
Recurrence Type
Maximum Length:30
Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly. -
RecurUpdatedAttributes: string
Title:
Recurrence Updated Attributes
Maximum Length:4000
The recurring updated attributes. -
RecurWedFlag: boolean
Title:
Wednesday
Maximum Length:1
Repeats on Wednesday. -
RecurWeekday: string
Title:
Pattern Type
Maximum Length:30
It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day -
ReferenceCustomerActTypeCode: string
Title:
Reference Customer Activity Type
Maximum Length:30
Activity Type for a reference customer activity. To be used as an extension only. -
ReferenceCustomerId: integer
(int64)
Title:
Reference Customer
The unique identifier of the reference customer (party) associated with the activity. -
ReminderPeriod: string
Title:
Set Reminder
The reminder period. -
ResourceNumber: string
Title:
Resource Number
Read Only:true
Maximum Length:30
Resource Number of owner associated with the activity. -
ResponseCode: string
Title:
Response
The response code. -
SalesObjectiveName: string
Title:
Sales Objective
The sales objective name associated to the activity. -
SalesObjectiveNumber: string
Title:
Sales Objective Number
Sales Objective Number of the sales objective associated with the activity. -
SearchDate: string
(date-time)
The date filter used in search (Not for public usage).
-
SelectedFlag: boolean
Default Value:
false
The records selected for Mass Update (Not for public usage). -
ShowStatus: string
Title:
Show
Maximum Length:255
Indicates whether the activity is open, complete. -
ShowTimeAs: string
Title:
Show Time As
The show time. -
SmartActionContext: string
Title:
Smart Action Context
Maximum Length:4000
Stores metadata needed for smart action. -
SmartActionId: integer
(int64)
Title:
Smart Action ID
The smart action identifier. Foriegn key from zca_user_action. -
SortDate: string
(date-time)
Title:
Date
This is an internal column which is used to sort the activity based on the due date for task and start date for activity. -
SourceObjectCode: string
The code of the object to which activity will get related to.
-
SourceObjectId: integer
The unique identifier of the object to which activity will get related to.
-
SrId: integer
(int64)
Title:
Service Request ID
The unique identifier of the service request. -
SrNumber: string
Title:
Service Request
The alternate identifier of the service request. -
StartDateForCallReport: string
(date-time)
The start date of the call report.
-
StartDateForCallReportAttr: string
(date-time)
The attribute for start date of the call report (Not for public usage).
-
StartDtRFAttr: string
(date-time)
The attribute for Activity Start Date (Not for public usage).
-
StatusCode: string
Title:
Status
Maximum Length:30
The status of the activity. Defaulted to NOT_STARTED. -
Subject: string
Title:
Subject
Maximum Length:500
The subject, name, or title of the activity. -
SubmittedBy: integer
(int64)
Title:
Submitted By
The user who submitted the report. -
SubmittedByName: string
Title:
Submitted By
Maximum Length:255
The user who submitted the report. -
SubmittedDate: string
(date-time)
Title:
Submitted Date
The date when the report was submitted. -
SwitchCallId: string
Title:
Switch Call ID
Maximum Length:128
The unique identifier of the call on the external phone system. -
TaskReminderPeriod: string
Title:
Due Date Reminder
Task Reminder Period -
TemplateDuration: number
Title:
Template Duration
The duration (in days) of the template activity. This attribute is used with the start date when generating an activity from a template in order to calculate the due date. -
TemplateFlag: string
Title:
Template
Maximum Length:1
Default Value:N
Indicates whether this is a template activity. -
TemplateId: integer
(int64)
Title:
Template ID
The unique identifier of the template. -
TemplateLeadTime: number
Title:
Lead Time
The lead time (in days) of the template activity. This attribute is used with the date input parameter when generating an activity from a template in order to calculate the activity start date. Activity start date is equal to date provided as input parameter and lead time. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the user has access to update the record. -
UpgSourceObjectId: string
Read Only:
true
Maximum Length:64
The primary key value of the record in the source table that is upgraded to activity record. -
UpgSourceObjectType: string
Read Only:
true
Maximum Length:30
The source object type could be Appointment, Task, or Interaction to indicate the source of the upgraded record. -
WebConferenceDetails: string
(byte)
Title:
Web Conference Details
Web conference details -
WebConferenceId: string
Title:
Web Conference ID
Maximum Length:255
Web conference unique id -
WebConferenceURL: string
Title:
Web Conference URL
Maximum Length:2000
Web conference join URL -
WebconfSyncStatusFlag: boolean
Title:
Web Conference Synchronization
Maximum Length:1
Appointment Interaction Status
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : assets-assetContacts-item-response
Type:
Show Source
object
-
AssetContactId: integer
(int64)
Title:
Asset Contact ID
The unique identifier of the primary contact associated with the asset. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of the Asset. -
AssetNumber: string
Title:
Asset Number
Read Only:true
Maximum Length:100
The number that identifies the asset. -
ContactFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the function of a contact. A list of valid values is defined in the lookup FunctionTypesLookupPVO. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The unique identifier of the party associated with the primary contact. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The unique identifier of the contact associated with the asset. -
ContactSourceSystem: string
Title:
Contact Source System
The system from where the contact associated with the asset is sourced. -
ContactSourceSystemReference: string
Title:
Contact Source System Reference
The reference system from where the contact associated with the asset is sourced. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created or imported the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the primary contact associated with the asset. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the primary contact associated with the asset. -
JobTitle: string
Title:
Job Title
Read Only:true
Maximum Length:100
The title of the job of the asset contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the account, or contact associated with the asset. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the primary contact. -
PersonProfileId: integer
(int64)
Title:
Contact Party ID
Read Only:true
The unique identifier of the contacts profile. -
PrimaryFlag: boolean
Title:
Primary
Indicates whether the asset contact is the primary contact. If the value is true, then the asset contact is a primary contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-assetLeads-item-response
Type:
Show Source
object
-
AcceptedDate: string
(date)
Title:
Accepted Date
Read Only:true
The date on which lead was accepted by a resource assigned to it. -
AcceptedDateTime: string
(date-time)
Title:
Accepted Date
Read Only:true
The date and time when the sales lead is accepted by a resource assigned to it. -
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The name of the owner of a sales lead. -
AddrElementAttribute1: string
Title:
Contact Address Attribute 1
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Contact Address Attribute 2
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Contact Address Attribute 3
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Contact Address Attribute 4
Maximum Length:150
Additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Contact Address Attribute 5
Maximum Length:150
Additional address element to support flexible address format. -
AddressLinesPhonetic: string
Title:
Contact Phonetic Address
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines (used in Japan). -
AILeadScore: number
Title:
AI Lead Score
Read Only:true
The AI calculated probability of the lead being converted to an opportunity. -
ApprovalDate: string
(date)
Title:
Registration Approval Date
The date on which a partner registered lead is approved by internal channel manager. -
ApprovalDateTime: string
(date-time)
Title:
Registration Approval Date
The date and time when the sales lead is approved. This is only applicable to deal registrations. -
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier for the asset associated with the sales lead. -
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The unique number for the asset associated with the sales lead. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The serial number for the asset associated with the sales lead. -
AssignmentStatusCode: string
Title:
Assignment Status
Maximum Length:30
Includes the current assignment related status for the lead, for example whether the lead is assigned or unassigned. -
BudgetAmount: number
Title:
Budget Amount
The budget amount associated with this sales lead. -
BudgetCurrencyCode: string
Title:
Budget Currency
Maximum Length:80
The currency code associated with the budget amount associated with this sales lead. -
BudgetStatus: string
Title:
Budget Status
Maximum Length:120
The budget status associated with the budget amount associated with this sales lead. -
Building: string
Title:
Building
Maximum Length:40
The specific building name or number at a given address. -
BusinessUnitId: integer
(int64)
Title:
Business Unit Identifier
The business unit identifier associated with the business unit of the sales lead creator. -
CampaignName: string
Title:
Campaign
Read Only:true
Maximum Length:250
The name of the campaign associated with the sales lead. -
ChannelType: string
Title:
Source
Maximum Length:30
The channel through which this lead contacted the company. -
ClassCode1: string
Title:
Industry Classification Code
Maximum Length:30
The auxiliary dimension for the Account. -
ClassCode2: string
Title:
Auxiliary Classification Code 1
Maximum Length:30
The auxiliary dimension for the Account. -
ClassCode3: string
Title:
Auxiliary Classification Code 2
Maximum Length:30
The auxiliary dimension for the Account. -
ClassCode4: string
Title:
Auxiliary Classification Code 3
Maximum Length:30
The auxiliary dimension for the Account. -
ConflictId: integer
(int64)
Title:
Conflict Identifier
Default Value:1
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
ContactDoNotPreference: boolean
Title:
Don't Contact Preference
Maximum Length:30
Indicates that the primary contact of the service request does not want to be contacted. -
ContactFormattedAddress: string
Title:
Primary Contact Address
Read Only:true
The primary address of a lead's primary contact. -
ContactPartyNumber: string
Title:
Primary Contact Number
Read Only:true
Maximum Length:30
The account number alternate key for referenced customer. -
ContactTimezoneCd: string
Title:
Contact Time Zone
Maximum Length:35
The preferred time zone of the contact pursued on the lead. -
ConvertedDateTime: string
(date-time)
Title:
Converted Date
The date and time when the sales lead is converted to an opportunity. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code for the lead. -
CustomerId: integer
(int64)
Title:
Customer ID
The unique identifier of the customer. It is a reference to the customer record in the TCA schema. -
CustomerNeed: string
Title:
Customer Need
Maximum Length:30
Indicates what need the lead product serves for the lead customer. -
CustomerPartyName: string
Title:
Account Name
Maximum Length:360
The name of the customer. -
DealAmount: number
Title:
Deal Size
The total amount attributed to a lead. -
DecisionMakerIdentifiedFlag: boolean
Title:
Decision Maker Identified
Maximum Length:120
Default Value:false
Indicates if the decision maker at customer site has been identified. -
DeleteFlag: boolean
Read Only:
true
Indicates if the user has access to delete the record. -
Description: string
Title:
Description
Maximum Length:2000
The description associated with this sales lead. -
Distance: number
Title:
Distance
Read Only:true
The distance from the input location. -
EligibleForConversionFlag: boolean
Title:
Eligible for Conversion
Maximum Length:1
Specifies whether the lead is eligible for conversion to opportunity. -
EnableCreateAccount: string
Title:
Create Account
Maximum Length:1
Indicates whether new account should be created during lead conversion. -
EnableCreateContact: string
Title:
Create Contact
Maximum Length:1
Indicates whether new contact should be created during lead conversion. -
EstimatedCloseDate: string
(date)
Title:
Estimated Close Date
The estimated close date for a deal once registered. -
ExpirationDate: string
(date)
Title:
Expiration Date
The expiration date associated with this sales lead. -
FloorNumber: string
Title:
Contact Address Floor Number
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FollowupTimestamp: string
(date)
Title:
Next Follow-up Date
Indicates when the sales lead needs to be followed up. -
FormattedPhoneNumber1: string
Title:
Contact Phone
Read Only:true
The formatted phone number of the primary contact for the lead. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset
The unique identifier for the IB Asset associated with the sales lead. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
The unique number for the IB Asset associated with the sales lead. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The unique serial number for the IB Asset associated with the sales lead. -
InventoryItemDescription: string
Title:
Product Item
Maximum Length:240
The description of the product added to a lead. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the primary contact on the sales lead. -
LastAssignmentDate: string
(date-time)
Title:
Last Automatic Assignment Date
The date on which the lead was last reassigned. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
Latitude: number
Title:
Latitude
The latitude information for the location. -
LeadAcceptedFlag: boolean
Title:
Accepted
Maximum Length:4
Indicates if the lead has been accepted. -
LeadAging: number
Title:
Age in Days
Read Only:true
The number of days elapsed since the lead was created. -
LeadCreatedBy: string
Title:
Lead Created By
Maximum Length:64
The user who created this record. -
LeadCreationDate: string
(date-time)
Title:
Lead Creation Date
The date and time when this record is created. -
LeadId: integer
(int64)
Title:
Lead Identifier
The unique identifier of the lead. -
LeadLastUpdateDate: string
(date-time)
Title:
Lead Last Update Date
The date and time of the last update of the row. -
LeadLastUpdatedBy: string
Title:
Lead Last Updated By
Maximum Length:64
The user who last updated the row. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The user friendly unique identifier for a lead. -
LeadOrigin: string
Title:
Origin
Maximum Length:30
Default Value:SALES_LEAD
The origin of the lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Title:
Longitude
The longitude information for the location. -
Name: string
Title:
Lead Name
Maximum Length:250
The name of the lead used for identifying the lead. -
OpportunityName: string
Title:
Opportunity Name
The name of the opportunity created from converting the lead. -
OpportunityOwnerNumber: string
Title:
Opportunity Owner Number
The alternate identifier for the owner of the opportunity created from converting the lead. -
OrganizationSize: string
Title:
Organization Size
Maximum Length:30
The size of the organization. -
OrganizationType: string
Title:
Organization Type
Maximum Length:30
The type of the organization. -
OwnerId: integer
(int64)
Title:
Owner ID
The party identifier associated with the owner of this sales lead. -
OwnerPartyName: string
Title:
Owner
Maximum Length:360
The name associated with the owner of this sales lead. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The alternate identifier of the primary contact. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The alternate partner number key for the referenced partner company. -
PartnerId: integer
(int64)
Title:
Primary Partner Identifier
The unique identifier for the primary partner associated with the lead. -
PartnerPartyName: string
Title:
Primary Partner
The name associated with the primary partner of this sales lead. This is a deal specific attribute. -
PartnerProgramId: integer
(int64)
Title:
Partner Program
A reference to the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute. -
PartnerProgramNumber: string
Title:
Partner Program Number
Maximum Length:30
The partner program number alternate key for the referenced partner program. -
PartnerType: string
Title:
Partner Type
Maximum Length:30
Indicates the type of the primary partner associated with this sales lead. This is a deal specific attribute. -
PostalPlus4Code: string
Title:
Postal Code
Maximum Length:10
The four digit extension to the United States Postal ZIP code. -
PrimaryCampaignId: integer
(int64)
Title:
Primary Campaign ID
The unique identifier of the primary campaign of the Lead. It is a reference key to campaign object. -
PrimaryCampaignName: string
Title:
Primary Campaign
The name of the primary campaign of the lead. -
PrimaryCampaignNumber: string
Title:
Primary Campaign Number
Maximum Length:30
The alternate identifier for primary campaign of the lead. -
PrimaryCompetitorName: string
Title:
Primary Competitor
The name of the primary competitor of the lead. -
PrimaryCompetitorPartyId: integer
Title:
Primary Competitor Party ID
The unique identifier of the primary competitor of the lead. It is a reference key to competitor object. -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
The alternate identifier for primary competitor of the lead. -
PrimaryContactAddress1: string
Title:
Primary Contact Address 1
Maximum Length:240
The first line of address associated with the primary contact of the lead. -
PrimaryContactAddress2: string
Title:
Primary Contact Address 2
Maximum Length:240
The second line of address associated with the primary contact of the lead. -
PrimaryContactAddress3: string
Title:
Primary Contact Address 3
Maximum Length:240
The third line of address associated with the primary contact of the lead. -
PrimaryContactAddress4: string
Title:
Primary Contact Address 4
Maximum Length:240
The fourth line of address associated with the primary contact of the lead. -
PrimaryContactCity: string
Title:
Primary Contact City
Maximum Length:60
The city where the primary contact of the lead is located. -
PrimaryContactCountry: string
Title:
Country
Maximum Length:2
The country where the primary contact of the lead is located. -
PrimaryContactCountryName: string
Title:
Country Name
Read Only:true
The full name associated with primary contact country code. -
PrimaryContactCounty: string
Title:
Primary Contact County
Maximum Length:60
The county where the primary contact of the lead is located. -
PrimaryContactEmailAddress: string
Title:
Contact Email
Maximum Length:320
The email address for the primary sales lead contact on the lead. -
PrimaryContactEmailPreference: string
Title:
Email Preference
Maximum Length:30
Indicates if the primary contact has an email preference of do not email, ok to email, or no value. -
PrimaryContactEmailVerificationDate: string
(date-time)
Title:
Email Verification Date
The verification date for primary contact email address. -
PrimaryContactEmailVerificationStatus: string
Title:
Email Verification Status
Maximum Length:30
The verification status for primary contact email address. -
PrimaryContactId: integer
(int64)
Title:
Primary Contact ID
The identifier of the sales lead contact marked as a primary lead contact. -
PrimaryContactMailPreference: string
Title:
Mail Preference
Maximum Length:30
Indicates if the primary contact has a mail preference. -
PrimaryContactPartyName: string
Title:
Primary Contact Name
Maximum Length:450
The name associated with the primary lead contact. -
PrimaryContactPersonFirstName: string
Title:
Primary Contact First Name
Maximum Length:150
The first name of the primary contact for a lead. -
PrimaryContactPersonLastName: string
Title:
Primary Contact Last Name
Maximum Length:150
The last name of the primary contact for a lead. -
PrimaryContactPersonMiddleName: string
Title:
Primary Contact Middle Name
Maximum Length:150
The middle name of the primary contact for a lead. -
PrimaryContactPhonePreference: string
Title:
Phone Preference
Maximum Length:30
Indicates if the primary contact has a phone preference of do not call, ok to call, or no value. -
PrimaryContactPostalCode: string
Title:
Primary Contact Postal Code
Maximum Length:60
The zip code where the primary contact of the lead is located. -
PrimaryContactProvince: string
Title:
Primary Contact Province
Maximum Length:60
The province where the primary contact of the lead is located. -
PrimaryContactRelationshipId: integer
(int64)
Title:
Primary Contact Relationship ID
The unique identifier of the relationship primary contact has with its parent organization. -
PrimaryContactState: string
Title:
Primary Contact State
Maximum Length:60
The state where the primary contact of the lead is located. -
PrimaryInventoryItemId: integer
(int64)
Title:
Primary Product ID
The unique identifier of the primary product associated with a lead. -
PrimaryInventoryItemNumber: string
Title:
Primary Inventory Item Number
Read Only:true
Maximum Length:300
The alternate key for referenced the primary inventory item. -
PrimaryInventoryOrgId: integer
(int64)
Title:
Primary Product Organization ID
The unique identifier of the organization to which the primary product associated with a lead belongs. -
PrimaryPhoneAreaCode: string
Title:
Primary Phone Area Code
Maximum Length:10
The primary phone area code for the sales lead contact. -
PrimaryPhoneCountryCode: string
Title:
Primary Phone Country Code
Maximum Length:10
The primary phone country code for the sales lead contact. -
PrimaryPhoneNumber: string
Title:
Contact Phone
Maximum Length:40
The primary phone number for the sales lead contact. -
PrimaryPhoneVerificationDate: string
(date-time)
Title:
Primary Phone Verification Date
The verification date for lead primary phone. -
PrimaryPhoneVerificationStatus: string
Title:
Primary Phone Verification Status
Maximum Length:30
The verification status for lead primary phone. -
PrimaryProductGroupId: integer
Title:
Primary Product Group ID
The unique identifier of the primary product group associated with a lead. -
PrimaryProductGroupReferenceNumber: string
Title:
Primary Product Group Reference Number
Maximum Length:50
The alternate key for the referenced primary product group. -
ProductGroupDescription: string
Title:
Product Group Description
Read Only:true
Maximum Length:1000
The description of the product or product group associated with a lead. -
ProductGroupName: string
Title:
Product Group
Maximum Length:250
The name of the product group associated with a lead. -
ProductType: string
Title:
Product Type
The type of the primary product, such as item or product group. -
ProgramName: string
Title:
Partner Program
The name of the partner program in which the primary partner associated with this sales lead is enrolled. This is a deal specific attribute. -
Project: string
Title:
Customer Project
Maximum Length:30
The customer project identified for this sales lead. -
QualificationScore: integer
(int64)
Title:
Qualification Score
Read Only:true
Default Value:0
The qualification score for a lead. -
QualifiedDate: string
(date)
Title:
Qualification Date
Indicates the date when this sales lead was qualified. -
QualifiedDateTime: string
(date-time)
Title:
Qualification Date
The date and time when the sales lead is qualified. -
Rank: string
Title:
Rank
Maximum Length:30
The rank associated with this sales lead. -
RawPrimaryPhoneNumber: string
Title:
Raw Phone Number
The raw value of the lead primary phone number. -
ReassignComment: string
Title:
Reassign Comments
Maximum Length:1000
The comment provided by a user while requesting the lead reassignment. -
ReassignReasonCode: string
Title:
Reassign Reason
Maximum Length:30
The pre-defined code used to indicate the reason for lead reassignment. -
RecordSet: string
Title:
Record Set
Read Only:true
The record visibility filters for lead search based on the resource and the leads to which the resource is associated to. The set is a group of lead records considered as the base group before other search criteria is used to further refine the search results. -
RegistrationNumber: string
Title:
Registration Number
Maximum Length:120
The registration number of the sales lead. This unique identifier is generated when the sales lead is approved. This is a deal specific attribute. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:120
The approval status of the sales lead. This is a deal specific attribute. -
RegistrationType: string
Title:
Registration Type
Maximum Length:120
The registration type of the sales lead. This is a deal specific attribute. -
RejectByUserId: integer
(int64)
Title:
Reject by User ID
The identifier of the sales representative who rejected this sales lead. -
RejectComment: string
Title:
Rejection Comments
Maximum Length:250
The comments provided by the sales representative who rejected this sales lead. -
RejectedDateTime: string
(date-time)
Title:
Rejected Time Stamp
The date and time when the sales lead is rejected. -
RejectReasonCode: string
Title:
Reject Reason
Maximum Length:30
The pre-defined code used to indicate the reason for rejecting a lead. -
RetireComment: string
Title:
Retirement Comments
Maximum Length:250
The comments recorded when the sales lead is moved to a retired status. -
RetiredDateTime: string
(date-time)
Title:
Retired Time Stamp
The date and time when the sales lead is moved to a retired status. -
RetireReasonCode: string
Title:
Retire Reason
Maximum Length:30
The pre-defined code used to indicate the reason for retiring a lead. -
SalesChannel: string
Title:
Sales Channel
Maximum Length:120
Indicates the sales channel responsible for following up on this sales lead. -
SalesTargetLeadEloquaSyncDate: string
(date-time)
Title:
Last Sync to Marketing Date
The date on which the current sales target lead contacts are last synced to Eloqua. -
SalesTargetLeadOptOutComment: string
Title:
Opt-out Comment
Maximum Length:1000
The comments provided by the sales representative who opted out this lead. -
SalesTargetLeadOptOutDate: string
(date-time)
Title:
Opt-out Date
The date of opting out the lead from sales target campaign. -
SalesTargetLeadOptOutReasonCode: string
Title:
Opt-out Reason
Maximum Length:32
The reason for opting out the lead from sales target campaign. -
SalesTargetLeadStage: string
Title:
Stage
Maximum Length:32
The lead's current stage in the account based selling process. -
SalesTargetLeadValidationDueDate: string
(date-time)
Title:
Validation Due Date
The date on which the sales target lead validation is due. -
Score: integer
(int64)
Title:
Score
The score associated with this sales lead. This score is computed based on the scoring rules. -
SourceCode: string
Title:
Source Code
Maximum Length:30
The marketing source code associated with this sales lead. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:UNQUALIFIED
The pre-defined code used to indicate the status of a lead. -
Timeframe: string
Title:
Time Frame
Maximum Length:120
The timeframe associated with this sales lead. -
ToReassignFlag: boolean
Title:
Reassign
Maximum Length:1
Default Value:false
Identifies leads that are marked for reassignment. -
UpdateFlag: boolean
Read Only:
true
Indicates if the user has access to update the record. -
WorkPhoneAreaCode: string
Title:
Work Phone Area Code
Maximum Length:10
The work phone area code for the sales lead contact. -
WorkPhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The work phone country code for the sales lead contact. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number for the sales lead contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-assetOpportunities-item-response
Type:
Show Source
object
-
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
The party number of the sales account that owns the opportunity. -
AssetId: integer
(int64)
The identifier of the asset of the opportunity.
-
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The asset number of the asset of the opportunity. -
AssetProduct: string
Title:
Asset
The associated asset's product name. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The associated asset's serial number. -
AssignmentMode: string
Title:
Assignment Mode
Maximum Length:30
Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates. -
AverageDaysAtStage: integer
(int64)
Title:
Duration
Read Only:true
The average days an opportunity remains in the current sales stage. -
BatchTag: string
Title:
Batch Tag
Maximum Length:30
This is used for tagging opportunities for inclusion in a batch job such as batch assignment of opportunities. -
BdgtAmount: number
Title:
Budget Amount
The budget amount from the sales account. -
BdgtAmtCurcyCd: string
Title:
Budget Amount Currency
Maximum Length:15
The currency code of the budget amount. -
BudgetAvailableDate: string
(date)
Title:
Date Budget Available
The date when the budget will be available. -
BudgetedFlag: boolean
Title:
Budgeted
Maximum Length:1
Default Value:false
Indicates if the opportunity sales account has its budget approved for the potential purchase. -
ChampionFlag: boolean
Title:
Key Internal Sponsor
Maximum Length:1
Default Value:false
Indicates if this opportunity has a key internal sponsor. -
ClosePeriod: string
Title:
Close Period
Read Only:true
The names of the filter on which opportunities can be filtered based on effective date range. -
Comments: string
Title:
Comments
Maximum Length:2000
The comments about this opportunity. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (such as mobile databases or the server). -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the opportunity. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the opportunity was created. -
CrmConversionRate: number
Title:
Conversion Rate
This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time. -
CrmCurrencyCode: string
Title:
CRM Common Currency
Read Only:true
Maximum Length:15
CRM common currency code. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency the opportunity amount is based on. -
CustomerAccountId: integer
(int64)
Title:
Billing Account
The customer account associated with the opportunity. -
DealHorizonCode: string
Title:
Estimated Deal Duration
Maximum Length:30
Indicates how long it may take to close the deal. This field refers to the lookup type MOO_SETID_DEAL_HORIZION. -
DecisionLevelCode: string
Title:
Decision Level
Maximum Length:30
Indicates the decision level at the opportunity sales account to commit. This field refers to the lookup type MOO_SETID_DECISION_LEVEL. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the user has access to delete the record. -
Description: string
Title:
Sales Objective
Maximum Length:2000
The description of the opportunity. -
DescriptionText: string
Title:
Description
Read Only:true
Maximum Length:255
The sales objective of the opportunity. -
DownsideAmount: number
Title:
Worst Case
Default Value:0
The worst case amount. -
EffectiveDate: string
(date)
Title:
Close Date
The estimated close date for the opportunity. -
EmailAddress: string
Title:
Owner Email
Read Only:true
Maximum Length:320
The e-mail address of the opportunity owner. -
ExpectAmount: number
Title:
Expected Revenue
Default Value:0
The expected revenue amount. -
ForecastCategory: string
Title:
Forecast Category
Maximum Length:30
Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on. -
ForecastOverrideCode: string
Title:
Include in Forecast
Maximum Length:30
Indicates whether the summary revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA. -
HintCode: string
Title:
Hint Code
Read Only:true
Maximum Length:10
The AI hint code. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset
The unique identifier of the installed base asset of the opportunity. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
The asset number of the installed base asset of the opportunity. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
The associated installed base asset's serial number. -
KeyContactId: integer
(int64)
Title:
Primary Contact
The unique identifier of the primary contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the row. -
LineOfBusinessCode: string
Title:
Line of Business
Maximum Length:30
The line of business that is responsible for the opportunity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCategory: string
Title:
Status Category
Read Only:true
Maximum Length:30
The status category of the opportunity. -
ManageGeneralProfileDataFlag: boolean
Title:
Manage General Profile Data
Read Only:true
Allows management of general opportunity information such as competitors, lead, source, contacts, references, interactions, and assessments. -
ManageRestrictedProfileDataFlag: boolean
Title:
Manage Restricted Profile Data
Read Only:true
Allows management of restricted opportunity information such as sales method, sales stage, sales account, primary contact, and partners. -
ManageRevenueDataFlag: boolean
Title:
Manage Revenue Data
Read Only:true
Allows management of revenue data, such as products and recurring revenue information. -
ManageTeamDataFlag: boolean
Title:
Manage Team Data
Read Only:true
Allows management of opportunity sales team data. -
MaximumDaysInStage: integer
(int64)
Title:
Stalled Deal Limit
Read Only:true
The maximum days the opportunity can be in the sales stage prior to considering it stalled. -
Name: string
Title:
Name
Maximum Length:275
The name of the opportunity associated with the asset. -
OpportunityOrigin: string
Title:
Opportunity Origin
Maximum Length:30
Default Value:SALES_OPTY
The value for the origin of the opportunity. -
OpportunityTypeCode: string
Title:
Opportunity Type
Maximum Length:30
The different types of opportunity such as new, renewal and expansion. -
OptyCreatedBy: string
Title:
Opportunity Created By
Maximum Length:64
The user who created the opportunity. -
OptyCreationDate: string
(date-time)
Title:
Opportunity Creation Date
The date when the opportunity was created. -
OptyId: integer
(int64)
Title:
Opportunity ID
The unique identifier of the opportunity. -
OptyLastUpdateDate: string
(date-time)
Title:
Opportunity Last Updated Date
The date when the opportunity was last updated. -
OptyLastUpdatedBy: string
Title:
Opportunity Last Updated By
Maximum Length:64
The user who last updated the opportunity. -
OptyNumber: string
Title:
Opportunity Number
Maximum Length:30
The alternate unique identifier of the opportunity associated with the asset. -
OwnerPartyNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
The party number of a valid employee resource who owns and manages the opportunity. -
OwnerResourcePartyId: integer
(int64)
Title:
Owner
The unique identifier of the opportunity owner. -
PartyName1: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the opportunity owner. -
PartyUniqueName1: string
Title:
Primary Competitor
Read Only:true
Maximum Length:900
The unique name of the primary opportunity competitor. -
PhaseCd: string
Title:
Phase
Read Only:true
Maximum Length:30
Default Value:"B - Working the Deal"
The current phase of the opportunity sales stage. -
PredWinProb: number
Title:
Predicted Win Probability
Read Only:true
The AI predicted win probability percent. -
PrimaryCampaignId: integer
(int64)
Title:
Primary Campaign ID
The unique identifier of the primary campaign of the opportunity. It is a reference key to campaign object. -
PrimaryCampaignName: string
Title:
Primary Campaign
The name of the primary campaign of the opportunity. -
PrimaryCampaignNumber: string
Title:
Primary Campaign Number
Maximum Length:30
The alternate identifier for primary campaign of the opportunity. -
PrimaryCompetitorId: integer
(int64)
Title:
Primary Competitor
The unique identifier of the primary competitor of this opportunity. -
PrimaryCompetitorPartyNumber: string
Title:
Primary Competitor Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the opportunity's primary competitor party. -
PrimaryContactEmailAddress: string
Title:
Primary Contact Email
Read Only:true
Maximum Length:320
The e-mail address of the primary contact. -
PrimaryContactEmailPref: string
Title:
Primary Contact Email Preference
Read Only:true
Maximum Length:255
Indicates if the primary contact has an email preference of do not email, ok to email, or no value. -
PrimaryContactFormattedPhoneNumber: string
Title:
Primary Contact Phone
Read Only:true
The formatted phone number for the primary contact on the opportunity. -
PrimaryContactPartyName: string
Title:
Primary Contact
Read Only:true
Maximum Length:360
The name of the primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the opportunity's primary contact party. -
PrimaryContactPhonePref: string
Title:
Primary Contact Phone Preference
Read Only:true
Maximum Length:255
Indicates if the primary contact has a phone preference of do not call, ok to call, or no value. -
PrimaryOrganizationId: integer
(int64)
Title:
Business Unit ID
Identifier of the business unit to which this opportunity belongs. -
PrimaryPartnerCompanyNumber: string
Title:
Primary Partner Number
Maximum Length:30
The alternate key identifier of the opportunity's primary partner company. -
PrimaryPartnerId: integer
(int64)
Title:
Primary Partner
The party ID of the primary partner. -
PrimaryPartnerOrgPartyName: string
Title:
Primary Partner
Maximum Length:360
The name of primary partner assigned to this opportunity. -
PrimaryRevenueId: integer
(int64)
Title:
Summary Revenue Line ID
The unique identifier for the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of an opportunity. -
PrimarySubscriptionId: integer
(int64)
Title:
Primary Subscription Id
The unique identifier for the primary subscription of an opportunity. -
PrimarySubscriptionNumber: string
Title:
Subscription Number
Read Only:true
Maximum Length:120
The alternate identifier for primary subscription of the opportunity. -
PrSrcNumber: string
Title:
Primary Source Number
Maximum Length:100
The primary marketing source or campaign that generated this opportunity. -
QuotaFactor: number
Title:
Quota Factor
Read Only:true
The quota factor of the opportunity sales stage. -
QuotedFlag: boolean
Title:
Quoted
Maximum Length:1
Default Value:false
Indicates that a quote has been created for this opportunity. -
RcmndWinProb: number
Title:
Win Probability
Read Only:true
Default Value:0
The recommended win probability for an opportunity in the sales stage -
ReasonWonLostCode: string
Title:
Win/Loss Reason
Maximum Length:30
The win or loss reason of the opportunity. Valid values from the MOO_SETID_WIN_LOSS_REASON lookup type. -
RecommendedAction: string
Title:
Recommended Action
Read Only:true
Maximum Length:180
The AI recommended action. -
RecordSet: string
Read Only:
true
The name of the predefined opportunity search filters. -
Registered: string
Title:
Registered
Maximum Length:30
Indicates deal registration status. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:30
The registration status of the partner who created the opportunity or deal. -
RegistrationType: string
Title:
Registration Type
Maximum Length:30
The registration type used for this partner. -
RenewalProcess: string
Title:
Renewal Process
Maximum Length:30
The renewal process can be manual, do not renew or automatic renewal. -
Revenue: number
Title:
Amount
Default Value:0
The revenue amount associated with the opportunity. -
RiskLevelCode: string
Title:
Level of Risk
Maximum Length:30
Indicates the risk level for this opportunity. This field refers to the lookup type MOO_SETID_RISK_LEVEL. -
SalesAccountUniqueName: string
Title:
Customer Account
Read Only:true
Maximum Length:900
The name of the sales account. -
SalesChannelCd: string
Title:
Sales Channel
Maximum Length:50
Indicates the sales channel for the opportunity. -
SalesMethod: string
Title:
Sales Method
Read Only:true
Maximum Length:50
The sales method of the opportunity. -
SalesMethodId: integer
(int64)
Title:
Sales Method
The unique identifier of the sales method for this opportunity. This indicates the sales process used. -
SalesStage: string
Title:
Sales Stage
Read Only:true
Maximum Length:50
The sales stage of the opportunity. -
SalesStageId: integer
(int64)
Title:
Sales Stage
The unique identifier of the sales stage of the opportunity. -
Selected: boolean
This is used during mass update scenarios from UI.
-
SetupRefCode: string
Maximum Length:
80
The public unique identifier for the CPQ configuration setup. -
SourceType: string
Title:
Source Type
Read Only:true
The type of the source. -
StageStatusCd: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:"Open"
The default status for the opportunity sales stage. -
StatusCode: string
Title:
Status
Maximum Length:30
The status of the opportunity. Valid values from the MOO_OPTY_STATUS lookup type. -
StgOrder: number
Title:
Order
Read Only:true
The order of the opportunity's sales stage within the sales method. -
StrategicLevelCode: string
Title:
Strategic Value
Maximum Length:30
Indicates the level of the strategic value to work with the opportunity sales account. This field refers to the lookup type MOO_SETID_STRATEGIC_VALUE. -
TargetPartyId: integer
(int64)
Title:
Account
The unique identifier of the opportunity sales account. -
TargetPartyName: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the sales account. -
TargetPartyPrimaryAddressCountry: string
Title:
Account Country
Read Only:true
Maximum Length:2
The country of the primary account's primary address. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the user has access to update the record. -
UpsideAmount: number
Title:
Best Case
Default Value:0
The best case amount. -
WinProb: integer
(int32)
Title:
Win Probability
The opportunity win probability.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-assetResources-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Title:
Asset ID
The unique identifier of the Asset. -
AssetNumber: string
Title:
Asset Number
Read Only:true
Maximum Length:100
The number that identifies the asset. -
AssetResourceId: integer
(int64)
Title:
Asset Resource ID
The unique identifier of the resource associated with the asset. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created or imported the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EmailAddress: string
Title:
Email
The e-mail address of the asset team member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberFunctionCode: string
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. -
OwnerFlag: boolean
Title:
Owner
Indicates whether the asset resource is the owner of the asset. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the account, or contact associated with the asset. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the asset resource. -
PrimaryPhoneAreaCode: string
Title:
Primary Phone Area Code
Read Only:true
Maximum Length:20
The phone area code of the asset resource. -
PrimaryPhoneCountryCode: string
Title:
Primary Phone Country Code
Read Only:true
Maximum Length:10
The phone country code of the asset resource. -
PrimaryPhoneExtension: string
Title:
Extension
Read Only:true
Maximum Length:20
The phone extension code of the asset resource. -
PrimaryPhoneLineType: string
Title:
Phone Line Type
Read Only:true
Maximum Length:30
The type of the phone line of the asset resource. -
PrimaryPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The primary phone number of the asset team member. -
ResourceId: integer
(int64)
Title:
Resource Party ID
The identifier of the party associated with the asset resource. -
ResourcePartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
The unique identifier of the resource associated with the asset. -
RoleName: string
Title:
Title
Read Only:true
The name of the role of an asset resource in the resource team. -
Status: string
Title:
Party Status
Read Only:true
Maximum Length:1
The user-defined status of the asset team member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-assetServiceRequests-item-response
Type:
Show Source
object
-
AccountPartyEmailAddress: string
Title:
Account Party Email Address
Read Only:true
Maximum Length:320
Indicates the e-mail ID of the account on the service request. -
AccountPartyFormattedPhoneNumber: string
Title:
Account Party Formatted Phone Number
Read Only:true
Indicates the formatted phone number of the account on the service request. -
AccountPartyId: integer
(int64)
Title:
Account ID
The unique party object ID of the account associated to the service request. -
AccountPartyName: string
Title:
Account Name
Read Only:true
Maximum Length:360
The party name associated with the account. -
AccountPartyNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
Indicates the alternate key for the account identifier. -
AccountPartyPreferredContactMethod: string
Title:
Account Party Preferred Contact Method
Read Only:true
Maximum Length:30
Indicates the preferred contact method of the account on the service request. -
AccountPartyUniqueName: string
Title:
Account
Maximum Length:900
The unique party name associated with the account. -
AffectedPartyAssignmentNumber: string
Title:
Affected Party Person Assignment Number
Maximum Length:50
The assignment number of the affected party. -
AffectedPartyPersonId: string
Title:
Affected Party
Indicates the contact unique identifier of the party affected in the service request -
AffectedPartyPersonName: string
Title:
Affected Party Person Name
Read Only:true
Indicates the display name of the affected party person in the service request -
AssetId: integer
(int64)
Title:
Asset
The unique identifier of the asset associated to the service request. -
AssetNumber: string
Title:
Asset Number
Maximum Length:100
The Asset Number of the asset that is associated to the service request -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:100
The serial number of the asset that is associated to the service request. -
AssigneeEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the assignee -
AssigneeFormattedAddress: string
Title:
Assignee Formatted Address
Read Only:true
Formatted Address of the SR Assignee. -
AssigneeFormattedPhoneNumber: string
Title:
Assignee Phone
Read Only:true
Indicates the phone number of the resource to whom the service request is assigned. -
AssigneePartyId: integer
(int64)
Title:
Assigned to Party ID
Read Only:true
The unique party object ID of the service request assignee. -
AssigneePersonName: string
Title:
Assigned To
Maximum Length:360
The email address of the assignee. -
AssigneeResourceId: integer
(int64)
Title:
Assigned to Resource ID
The unique identifier of the resource (for example, a support engineer) assigned to the service request. -
AssigneeResourceNumber: string
Title:
Assigned to Resource Number
Read Only:true
Maximum Length:30
Indicates the alternative key for the resource identifier of the assignee. -
BillToCustomerAccountDescription: string
Title:
Bill-To Customer Account Description
Read Only:true
Maximum Length:240
The description of the customer account to be billed for work performed on the service request. -
BillToCustomerAccountId: integer
(int64)
Title:
Bill to Customer Account ID
The customer account to be billed for work performed on the service request. -
BillToCustomerAccountNumber: string
Title:
Bill-To Customer Account Number
Read Only:true
Maximum Length:30
The PUID for the customer account to be billed for work performed on the service request. -
BillToCustomerAccountSiteId: integer
(int64)
Title:
Bill to Customer Account Site ID
The customer account site to be billed for work performed on the service request. -
BillToCustomerAccountSiteUsageNumber: string
Title:
Bill-To Customer Account Site Usage Number
Maximum Length:255
The PUID for the customer account site bill-to usage. -
BillToCustomerId: integer
(int64)
Title:
Bill to Customer ID
The customer to be billed for work performed on the service request. -
BillToCustomerName: string
Title:
Bill-To Customer Name
Read Only:true
Maximum Length:360
The name of the customer to be billed for work performed on the service request. -
BillToCustomerNumber: string
Title:
Bill-To Customer Number
Read Only:true
Maximum Length:30
The PUID for the customer to be billed for work performed on the service request. -
BillToPartySiteFormattedAddress: string
Title:
Bill-To Party Site Formatted Address
Maximum Length:5000
The formatted address for the customer site to be billed for work performed on the service request. -
BillToPartySiteId: integer
(int64)
Title:
Bill-To Party Site ID
The address of the customer site to be billed for work performed on the service request. -
BillToPartySiteLocationId: integer
(int64)
Title:
Bill-To Party Site Location ID
Read Only:true
The location of the customer site to be billed for work performed on the service request. -
BillToPartySiteName: string
Title:
Bill-To Party Site Name
Read Only:true
Maximum Length:240
The name of the customer site to be billed for work performed on the service request. -
BillToPartySiteNumber: string
Title:
Bill-To Party Site Number
Read Only:true
Maximum Length:30
The PUID for the customer site to be billed for work performed on the service request. -
BUOrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit name associated to the service request. -
BusinessUnitName: string
Title:
Business Unit Name
Read Only:true
Maximum Length:255
The name of the business unit associated to the service request -
CaseId: integer
(int64)
Title:
Case ID
Indicates the case to which this service request has been associated. -
CaseNumber: string
Title:
Case Number
Maximum Length:255
Indicates the reference number of the case. -
CategoryCode: string
Title:
Category Code
Read Only:true
Maximum Length:290
Indicates the alternate key of the category associated to the service request. -
CategoryId: integer
(int64)
Title:
Category
The unique identifier of the service request category. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:400
The name of the category associated to the service request. -
ChannelId: integer
Title:
Channel
Indicates the service request channel. -
ChannelTypeCd: string
Title:
Channel Type
Maximum Length:30
Indicates the channel type. -
ChannelTypeCdMeaning: string
Title:
Channel Type Value
Read Only:true
Maximum Length:255
Indicates the display value corresponding to the channel type lookup code for the service request. -
ClosedDate: string
(date-time)
Title:
Date Closed
The date when the service request was closed (if closed). -
ComplianceFlag: boolean
Title:
Compliance
Read Only:true
Maximum Length:1
Indicates the compliance status of the milestone. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the service request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the service request was created. -
CriticalFlag: boolean
Title:
Critical
Maximum Length:1
Default Value:false
Indicates whether the service request is critical. If critical, the value is Y, else the value is N. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The corporate currency conversion rate type. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
This flag controls if the user has access to delete the record -
DueDate: string
(date-time)
Title:
Due Date
Read Only:true
Indicates the due date of the milestone. -
FirstTransferDate: string
(date-time)
Title:
First Transfer Date
Indicates the date and time of the first transfer of the service request. -
HeaderFlag: boolean
Title:
Header
Read Only:true
Maximum Length:1
Indicates if the current milestone should be saved on the service request header. -
IBAssetDescription: string
Title:
Installed Base Asset Description
Read Only:true
Maximum Length:240
Indicates the Install Base asset description of the service request. -
IBAssetId: integer
(int64)
Title:
Installed Base Asset ID
The unique identifier of the associated Install Base asset record. -
IBAssetLocation: string
Title:
Installed Base Asset Location
Maximum Length:5000
The formatted address of the installed base asset of the service request. -
IBAssetLocationType: string
Title:
Installed Base Asset Location Type
Read Only:true
Maximum Length:80
Indicates the type of location of the asset of the service request. -
IBAssetNumber: string
Title:
Installed Base Asset Number
Read Only:true
Maximum Length:80
Indicates the Installed Base asset number of the service request. -
IBAssetSerialNumber: string
Title:
Installed Base Asset Serial Number
Read Only:true
Maximum Length:80
Indicates the Install Base asset serial number of the service request. -
InternalPriorityCd: string
Title:
Internal Priority Code
Maximum Length:30
Indicates the internal priority of the service request. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the product associated to the service request. -
InventoryOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the organization of the product that is associated with the service request. -
LanguageCd: string
Title:
Language Code
Maximum Length:30
The customer's preferred language for the service request. -
LastReopenDate: string
(date-time)
Title:
Date Reopened
The date and time when the service request was last reopened. -
LastResolvedDate: string
(date-time)
Title:
Resolution Date
The date and time when the service request was resolved. -
LastTransferDate: string
(date-time)
Title:
Last Transfer Date
Indicates the date and time of the last transfer of the service request. -
LastTransferredBy: string
Title:
Last Transferred By
Maximum Length:64
Indicates the user who last transferred the service request. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the service request was last updated. -
LastUpdatedBy: string
Title:
Last Updated by Login ID
Read Only:true
Maximum Length:64
The user who last updated the service request. -
LastUpdatedByDisplayName: string
Title:
Last Updated By
Read Only:true
Maximum Length:3600
The display name of the user who last updated the service request. -
LastUpdatedByEmailAddress: string
Title:
Last Updated by Email Address
Read Only:true
Maximum Length:255
Indicates the e-mail address of the person who last updated the service request. -
LastUpdatedByPartyId: integer
(int64)
Title:
Last Updated by Party ID
Indicates the unique identifier of the person who last updated the service request. -
LastUpdatedByPartyNumber: string
Title:
Last Updated by Party Number
Read Only:true
Maximum Length:30
Indicates the alternative key for the party identifier of the person who last updated the service request. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The application login id of the user who last updated the service request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyMemberId: integer
(int64)
Title:
Loyalty Member
The unique identifier of the loyalty membership. -
LoyMemberName: string
Title:
Loyalty Member
Maximum Length:100
The member name of the loyalty membership. -
LoyMemberNumber: string
Title:
Loyalty Member Number
Read Only:true
Maximum Length:30
Indicates the alternative key for the loyalty member identifier. -
MilestoneConfigId: integer
(int64)
Title:
Configuration ID
Read Only:true
The unique identifier of the milestone configuration associated with the service request. -
MilestoneLabel: string
Title:
Milestone Name
Read Only:true
Maximum Length:255
The user defined name for the milestone. -
MilestoneStatusCd: string
Title:
Milestone Status
Read Only:true
Maximum Length:255
Indicates the status of the milestone. -
NetworkTypeCd: string
Title:
Network
Read Only:true
Maximum Length:30
Indicates the type of social network. -
OpenDate: string
(date-time)
Title:
Date Reported
The date when the service request was reported by the customer. -
OriginalSystemReference: string
Title:
Original System
Maximum Length:255
The reference to the service request record in the original system from which service request was imported (if imported). -
OwnerTypeCd: string
Title:
Owner Type
Maximum Length:30
Indicates the type of the service request owner. For example, the owner of the service request may be a customer or a partner. -
PartnerAccountPartyId: integer
(int64)
Title:
Partner Account Party ID
The unique party object ID of the partner account associated with the service request. -
PartnerAccountPartyName: string
Title:
Partner Account
Maximum Length:360
The party name associated with the partner. -
PartnerAccountPartyNumber: string
Title:
Partner Account Number
Read Only:true
Maximum Length:30
Indicates the alternative key for the partner account identifier. -
PartnerAccountPartyUniqueName: string
Title:
Partner Account
Maximum Length:900
The unique party name associated with the partner. -
PrimaryContactAssignmentNumber: string
Title:
Primary Contact Person Assignment Number
Maximum Length:50
The assignment number of the primary contact. -
PrimaryContactDoNotContactFlag: boolean
Title:
Primary Contact Do Not Contact
Read Only:true
Maximum Length:1
Indicates that the primary contact of the service request does not want to be contacted. -
PrimaryContactEmailAddress: string
Title:
Primary Contact Email
Read Only:true
Maximum Length:320
Indicates the e-mail of the primary contact associated with the service request. -
PrimaryContactFormattedAddress: string
Title:
Primary Contact Formatted Address
Read Only:true
Indicates the formatted address of the primary contact of the service request. -
PrimaryContactFormattedPhoneNumber: string
Title:
Primary Contact Phone
Read Only:true
Indicates the service request primary contact's formatted phone number -
PrimaryContactPartyId: integer
(int64)
Title:
Primary Contact ID
The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request. -
PrimaryContactPartyName: string
Title:
Primary Contact
Maximum Length:360
Indicates the name of the service request primary contact. -
PrimaryContactPartyNumber: string
Title:
Primary Contact Number
Read Only:true
Maximum Length:30
Indicates the alternative key for the primary contact identifier. -
PrimaryContactPartyUniqueName: string
Title:
Primary Contact Unique Name
Maximum Length:900
The unique party name associated with the primary contact. -
PrimaryContactPersonId: integer
(int64)
Title:
Primary Contact Person ID
The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request. -
PrimaryContactPreferredContactMethod: string
Title:
Primary Contact Preferred Contact Method
Read Only:true
Maximum Length:30
Indicates the preferred contact method of the primary contact of the service request. -
ProblemCd: string
Title:
Problem Type Code
Maximum Length:30
Indicates the problem code of the service request. -
ProblemDescription: string
Title:
Problem Description
Maximum Length:1000
The service request's problem description/statement and the steps to reproduce the issue. -
ProdGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group associated to the service request. -
ProdGroupName: string
Title:
Product Group
Maximum Length:255
The name of the product group associated to the service request. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Indicates the alternative key for the product group identifier. -
ProductItemDescription: string
Title:
Product Description
Maximum Length:255
The description of the product associated with the service request. -
ProductItemNumber: string
Title:
Product Number
Read Only:true
Maximum Length:255
The product number/code of the product associated with the service request. -
ProductItemOrgId: integer
(int64)
Title:
Product Organization
Read Only:true
Indicates the product organization. -
PurchaseOrder: string
Title:
Purchase Order
Maximum Length:50
Indicates the purchase order associated with the service request. -
QueueId: integer
(int64)
Title:
Assigned Queue ID
The unique identifier of the queue to which the service request is assigned. -
QueueName: string
Title:
Queue
Maximum Length:400
The name of the queue associated to the service request. -
QueueNumber: string
Title:
Queue Number
Read Only:true
Maximum Length:30
Indicates the alternative key for the queue identifier. -
RecordSet: string
Title:
Search Filter
Read Only:true
The field is used by REST API to manage saved searches. -
ReportedByEmailAddress: string
Title:
Reported by Email ID
Read Only:true
Maximum Length:320
Indicates the e-mail address of the person who reported the service request. -
ReportedByFormattedPhoneNumber: string
Title:
Reported by Phone Number
Read Only:true
Indicates the formatted phone number of the person who reported the service request. -
ReportedByPartyId: integer
(int64)
Title:
Reported by Party ID
The user who created the service request in the system. -
ReportedByPartyName: string
Title:
Reported By
Read Only:true
Maximum Length:360
The name of the party that reported the service request. -
ReportedByPartyNumber: string
Title:
Reported by Party Number
Read Only:true
Maximum Length:30
Indicates the alternative key for the party identifier of the person reporting the service request. -
ReportedByPartyUniqueName: string
Title:
Reported by Unique Name
Read Only:true
Maximum Length:900
The unique name of the user who created the service request. -
ResolutionCd: string
Title:
Resolution Code
Maximum Length:30
Indicates the resolution code of the service request. -
ResolutionCdMeaning: string
Title:
Resolution Value
Read Only:true
Indicates the display value corresponding to the resolution lookup code for the service request. -
ResolvedBy: string
Title:
Resolved By
Maximum Length:64
Indicates the user who resolved the service request. -
ResolveDescription: string
Title:
Solution Description
Maximum Length:1000
Indicates how the service request has been resolved. -
ResolveOutcomeCd: string
Title:
Outcome
Maximum Length:30
Indicates the outcome of a service request resolution. -
ResolveOutcomeCdMeaning: string
Title:
Outcome Value
Read Only:true
Indicates the display value corresponding to the resolution outcome lookup code for the service request. -
ServiceProfileId: integer
(int64)
Title:
Service Profile ID
The service profile associated with the service request. -
ServiceProfileName: string
Title:
Service Profile Name
Read Only:true
Maximum Length:400
The name of the service profile associated with the service request. -
ServiceProfileNumber: string
Title:
Service Profile Number
Read Only:true
Maximum Length:30
The PUID for the service profile associated with the service request. -
ServiceProfilePartySiteId: integer
(int64)
Title:
Service Profile Site ID
Read Only:true
The address of the service profile associated with the service request. -
ServiceProfilePartySiteLocationId: integer
(int64)
Title:
Service Profile Site Location ID
Read Only:true
The location of the service profile associated with the service request. -
ServiceProfilePartySiteName: string
Title:
Service Profile Site Party Name
Read Only:true
Maximum Length:240
The name of the address of the service profile associated with the service request. -
ServiceProfilePartySiteNumber: string
Title:
Service Profile Site Party Number
Read Only:true
Maximum Length:30
The PUID of the address of the service profile associated with the service request. -
ServiceProfileSiteFormattedAddress: string
Title:
Service Profile Formatted Address
Maximum Length:5000
The formatted address of the service profile associated with the service request. -
ServiceZoneId: integer
(int64)
Title:
Region Identifier
The unique identifier of the service zone for the service request. -
ServiceZoneName: string
Title:
Service Region
Read Only:true
Maximum Length:360
Indicates the service region of the service request. -
SeverityCd: string
Title:
Severity
Maximum Length:30
Indicates the severity of the service request. -
SeverityCdMeaning: string
Title:
Severity Value
Read Only:true
Indicates the display value corresponding to the severity lookup code for the service request. -
SeverityColorCd: string
Title:
Severity Color Code
Read Only:true
Indicates the color code for the severity of the service request -
SeverityRank: integer
Title:
Severity Rank
Read Only:true
Indicates the numeric code of the service request severity. -
SocialPrivateFlag: boolean
Title:
Private Social Post
Maximum Length:1
Default Value:false
Indicates if the service request was created from a private social post. -
SourceCd: string
Title:
Source Code
Maximum Length:30
Indicates how the service request was created in the application. -
SrCreatedBy: string
Title:
Source System SR Created By
Maximum Length:64
The user who created the service request. -
SrId: integer
(int64)
Title:
Service Request ID
Read Only:true
The unique identifier of the service request record. -
SrLastUpdateDate: string
(date-time)
Title:
Last Update Date in Source System
The date and time when the service request was last updated. -
SrLastUpdatedBy: string
Title:
Source System SR Last Updated By
Maximum Length:64
The user who last updated the service request. -
SrLastUpdateLogin: string
Title:
Source System SR Last Updated by User Login ID
Maximum Length:32
The application login id of the user who last updated the service request. -
SrMilestoneId: integer
(int64)
Title:
Milestone ID
Read Only:true
The unique identifier of the milestone associated to the service request. -
SrNumber: string
Title:
Reference Number
Maximum Length:30
The unique number that is used to identify a service request. You can customize the service request Number to a format that is best suitable to your organizational requirements. -
StatusCd: string
Title:
Status
Maximum Length:30
Indicates the status code of the service request. -
StatusCdMeaning: string
Title:
Status Value
Read Only:true
Indicates the display value corresponding to the status lookup code for the service request. -
StatusTypeCd: string
Title:
Status Type
Read Only:true
Maximum Length:30
Indicates the status type of the service request. -
StatusTypeCdMeaning: string
Title:
Status Type Value
Read Only:true
Indicates the display value corresponding to the status type lookup code for the service request. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
Indicates the application context of the service request. -
SurveyResponseDate: string
(date-time)
Title:
Survey Response Date
Read Only:true
The date and time when the response to this survey was submitted to the survey vendor. -
SurveySentDate: string
(date-time)
Title:
Survey Sent Date
Read Only:true
The date and time when survey was last sent for this service request. -
TimeRemaining: string
Title:
Time Remaining
Read Only:true
Indicates the time remaining in the milestone -
TimezoneCode: string
Title:
Time Zone Code
Maximum Length:50
The service request time zone used for computing the milestone due date. -
Title: string
Title:
Title
Maximum Length:400
A brief title of the service request. -
TransferCount: integer
(int64)
Title:
Transfer Count
The number of times a service request has been transferred. -
TransferNote: string
Title:
Transfer Note
Maximum Length:1500
This field contains information about transfer note. -
TransferReasonCd: string
Title:
Transfer Reason
Maximum Length:30
The lookup code that represents the transfer reason. -
UniqueExternalSystemReference: string
Title:
Unique External System Reference Number
Maximum Length:255
The unique alternative identifier of the service request in the original reference system. Use this column to store the identifier of the service request in the external application you are integrating with. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
This flag controls if the user has access to update the record -
WarnedFlag: boolean
Title:
Warned
Read Only:true
Maximum Length:1
Indicates that the milestone passed the warning threshold.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type in the attachment. A list of valid values is defined in the lookup WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .pang format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The session sign in of the user that last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attached file. -
UploadedText: string
Title:
Uploaded Text
The text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
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. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Indicates if the action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function for smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether the smart suggest is enabled for the action. -
SystemActionFlag: boolean
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. -
UpdateOfAttributes: string
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. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique identifier of the smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The 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 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. -
UserActionURLBinding: array
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
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. -
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 Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
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. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assets-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
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. -
URLBindingId: integer
(int64)
The unique identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all assets 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
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "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": [[ ..... ] }, { "AssetId": 784589507, "AssetNumber": "784589507", "AssetOrigSystem": null, "AssetOrigSystemReference": null, "BatchId": null, "AssetAmount": 0, "CreatedBy": "1", "CreationDate": "2010-07-23T14:16:45+00:00", "CustomerId": 999997550880043, "EndDate": null, "InstallDate": null, "InterfaceRowId": null, "InventoryItemId": 999997500677768, "InventoryOrgId": 204, "LastUpdateDate": "2010-07-23T14:16:45+00:00", "LastUpdateLogin": "-1", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "PurchaseDate": null, "Quantity": 1, "StartDate": "2005-06-06", "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 8000RT-360 Server", "OrganizationId": 204, "ProdGroupName": null, "Product": "Sentinel Power 8000RT-360 Server", "CompetitiveAsset": "N", "PrContactPartyId": null, "ResourceOwnerId": null, "Manufacturer": null, "Model": null, "Version": null, "Year": null, "AssetGroup": null, "links": [[ ..... ] }, ... }