Get all contracts
get
/fscmRestApi/resources/11.13.18.05/assetWarrantyContracts
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:- ContractsByRootAssetId: Returns a list of Contracts by a common root asset id.
Finder Variables:- RootAssetId; integer; Value that uniquely identifies a common root asset id.
- ContractsByRootAssetNumber: Returns a list of Contracts by a common root asset number.
Finder Variables:- RootAssetNumber; string; Value that uniquely identifies a common root asset number.
- ContractsByTransactionCode: Returns a list of contracts by a common root asset ID and repair transaction code.
Finder Variables:- BindRepairTransactionCode; string; Values that uniquely identifies a repair transaction code.
- BindRootAssetId; integer; Values that uniquely identifies a common root asset ID.
- PrimaryKey: Finds contract definitions according to the contract number.
Finder Variables:- ContractId; integer.
- ContractsByRootAssetId: Returns a list of Contracts by a common root asset id.
-
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:- AssetId; integer; Value that uniquely identifies an asset.
- AssetNumber; string; Number that uniquely identifies an asset.
- AssetSerialNumber; string; Serial number of an asset.
- CalculatedExpirationDate; string; Calculated expiration date of the warranty contract. This attribute is the latest expiration date among the contract meters.
- ContractEndDate; string; End Date of the warranty contract.
- ContractId; integer; Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
- ContractNotes; string; Notes of the warranty contract.
- ContractNumber; string; Number that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
- ContractStartDate; string; Start Date of the warranty contract. This attribute is required.
- ContractStatus; string; Name of the status for the warranty coverage.
- ContractStatusCode; string; Status of the warranty contract. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CONTRACT_STATUS. This attribute is required to create the coverage.
- CoverageCode; string; Abbreviation that uniquely identifies the warranty coverage. This attribute is required to create the warranty contract.
- CoverageDescription; string; Description of the warranty coverage.
- CoverageId; integer; Value that uniquely identifies the warranty coverage.
- CoverageName; string; Name of the warranty coverage.
- CreatedBy; string; Login username of the user who created the record.
- CreationDate; string; Date when the record was created.
- ExternalReferenceNumber; string; Number of an external reference to the warranty contract. This attribute is optinal.
- LastUpdateDate; string; Date when the record was updated.
- LastUpdatedBy; string; Login username of the user who updated the record.
- ObjectId; integer; Value that uniquely identifies the object in a warranty contract. This attribute is required.
- ObjectType; string; Name of the object type code.
- ObjectTypeCode; string; Abbreviation that uniquely identifies the type of object for the warranty contract. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CONTRACT_OBJECT. This attribute is required.
- RootAssetId; integer; Value that uniquely identifies the root asset.
- RootAssetNumber; string; Number that uniquely identifies the root asset.
- WarrantyProviderName; string; Value that identifies the warranty provider name attribute for the contracts.
- WarrantyProviderNumber; string; Value that identifies the warranty provider number attribute for the contracts.
-
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 : assetWarrantyContracts
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 : assetWarrantyContracts-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Read Only:
true
Value that uniquely identifies an asset. -
AssetNumber: string
Title:
Asset Number
Maximum Length:80
Number that uniquely identifies an asset. -
AssetSerialNumber: string
Title:
Asset Serial Number
Read Only:true
Maximum Length:80
Serial number of an asset. -
CalculatedExpirationDate: string
(date)
Title:
Contract Calculated Expiration Date
Calculated expiration date of the warranty contract. This attribute is the latest expiration date among the contract meters. -
ContractEndDate: string
(date)
Title:
Contract End Date
End Date of the warranty contract. -
ContractId: integer
(int64)
Title:
Contract ID
Read Only:true
Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract. -
contractMeters: array
Contract Meters
Title:
Contract Meters
The Contract Meters resource manages the asset meters for the contract. You can add, remove, and view the list of the asset meters. -
ContractNotes: string
Title:
Contract Notes
Maximum Length:2000
Notes of the warranty contract. -
ContractNumber: string
Title:
Contract Number
Maximum Length:80
Number that uniquely identifies the warranty contract. The application creates this value when it creates the contract. -
ContractStartDate: string
(date)
Title:
Contract Start Date
Start Date of the warranty contract. This attribute is required. -
ContractStatus: string
Title:
Contract Status Code Description
Read Only:true
Maximum Length:80
Name of the status for the warranty coverage. -
ContractStatusCode: string
Title:
Contract Status Code
Maximum Length:30
Default Value:ORA_READY
Status of the warranty contract. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CONTRACT_STATUS. This attribute is required to create the coverage. -
CoverageCode: string
Title:
Coverage Code
Maximum Length:80
Abbreviation that uniquely identifies the warranty coverage. This attribute is required to create the warranty contract. -
CoverageDescription: string
Title:
Coverage Description
Read Only:true
Maximum Length:240
Description of the warranty coverage. -
CoverageId: integer
(int64)
Title:
Coverage ID
Value that uniquely identifies the warranty coverage. -
CoverageName: string
Title:
Coverage Name
Read Only:true
Maximum Length:120
Name of the warranty coverage. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Login username of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
ExternalReferenceNumber: string
Title:
Contract External Reference Number
Maximum Length:80
Number of an external reference to the warranty contract. This attribute is optinal. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Login username of the user who updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object ID
Value that uniquely identifies the object in a warranty contract. This attribute is required. -
ObjectType: string
Title:
Object Type
Read Only:true
Maximum Length:80
Name of the object type code. -
ObjectTypeCode: string
Title:
Object Type Code
Maximum Length:30
Abbreviation that uniquely identifies the type of object for the warranty contract. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CONTRACT_OBJECT. This attribute is required. -
RootAssetId: integer
(int64)
Read Only:
true
Value that uniquely identifies the root asset. -
RootAssetNumber: string
Read Only:
true
Maximum Length:80
Number that uniquely identifies the root asset. -
WarrantyProviderName: string
Title:
Warranty Provider Name
Read Only:true
Maximum Length:360
Value that identifies the warranty provider name attribute for the contracts. -
WarrantyProviderNumber: string
Title:
Warranty Provider Number
Read Only:true
Maximum Length:30
Value that identifies the warranty provider number attribute for the contracts.
Nested Schema : Contract Meters
Type:
array
Title:
Contract Meters
The Contract Meters resource manages the asset meters for the contract. You can add, remove, and view the list of the asset meters.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : assetWarrantyContracts-contractMeters-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date)
Title:
Active End Date
Read Only:true
Date that indicates if a meter definition is disabled for a warranty contract. -
CalculatedDueDate: string
(date)
Title:
Calculated End Date
Read Only:true
The calculated contract due date value in a warranty contract. -
ContractId: integer
(int64)
Read Only:
true
Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract. -
ContractMeterId: integer
(int64)
Title:
Contract Meter ID
Read Only:true
Value that uniquely identifies the warranty contract meter. The application creates this value when it creates the contract meter. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Login user name of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Flag that is used to set the active end date of the contract meters.Valid values are Y and N. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Login user name of the user who updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterCode: string
Title:
Meter Code
Maximum Length:30
Abbreviation that uniquely identifies a meter definition in a warranty contract. -
MeterDescription: string
Title:
Meter Description
Read Only:true
Maximum Length:240
The description of a meter definition. -
MeterEndValue: number
Title:
Meter End Value
Read Only:true
End value for a meter in a warranty contract. -
MeterId: integer
(int64)
Title:
Meter ID
Value that uniquely identifies the meter definition in a warranty contract. The meter must be active for the asset number referenced in the contract. -
MeterIntervalValue: number
Title:
Meter Interval Value
The interval value for a meter in a warranty contract. -
MeterName: string
Title:
Contract Meter Name
Read Only:true
Maximum Length:120
The name of a meter definition. -
MeterStartValue: number
Title:
Meter Start Value
The start value for a meter in a warranty contract. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:25
Name of the unit of measure for the warranty. -
UOMCode: string
Title:
Unit of Measure Code
Read Only:true
Maximum Length:3
Abbreviation that uniquely identifies the unit of measure for the meter. A list of accepted values is defined in the lookup type TBD. This attribute is required if the Duration is defined, else it is optional.
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.
Examples
This example describes how to get all warranty contracts.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/assetWarrantyContracts"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "ContractId": 300100568130806, "ContractNumber": "300100568130806", "CoverageId": 300100568130805, "CoverageName": "ALM Coverage Dur Only", "CoverageCode": "ALM_COVERAGE_D", "CoverageDescription": "ALM COVERAGE Duration Only", "WarrantyProviderNumber": "123456", "WarrantyProviderName": "Provider1", "ObjectId": 300100566813034, "ObjectTypeCode": "ORA_ASSET", "ObjectType": "Asset", "AssetNumber": "ALM_ASSET_001", "AssetSerialNumber": null, "ContractStatusCode": "ORA_READY", "ContractStatus": "Ready", "ContractStartDate": "2022-10-01", "ContractEndDate": "2022-10-31", "CalculatedExpirationDate": null, "ExternalReferenceNumber": null, "ContractNotes": null, "CreatedBy": "USER", "CreationDate": "2022-10-28T15:42:12+00:00", "LastUpdateDate": "2022-10-28T15:42:12.001+00:00", "LastUpdatedBy": "USER", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806", "name": "assetWarrantyContracts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806", "name": "assetWarrantyContracts", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806/child/contractMeters", "name": "contractMeters", "kind": "collection" } ] }, { "ContractId": 300100568130904, "ContractNumber": "300100568130904", "CoverageId": 300100568130807, "CoverageName": "ALM Coverage Dur Only", "CoverageCode": "ALM_COVERAGE_D1", "CoverageDescription": "ALM COVERAGE Duration Only", "WarrantyProviderNumber": "654321", "WarrantyProviderName": "Provider2", "ObjectId": 300100566813034, "ObjectTypeCode": "ORA_ASSET", "ObjectType": "Asset", "AssetNumber": "ALM_ASSET_001", "AssetSerialNumber": null, "ContractStatusCode": "ORA_READY", "ContractStatus": "Ready", "ContractStartDate": "2022-10-01", "ContractEndDate": "2022-10-31", "CalculatedExpirationDate": null, "ExternalReferenceNumber": null, "ContractNotes": null, "CreatedBy": "USER", "CreationDate": "2022-10-28T15:46:26+00:00", "LastUpdateDate": "2022-10-28T15:46:26.001+00:00", "LastUpdatedBy": "USER", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904", "name": "assetWarrantyContracts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904", "name": "assetWarrantyContracts", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904/child/contractMeters", "name": "contractMeters", "kind": "collection" } ] }, ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts", "name": "assetWarrantyContracts", "kind": "collection" } ] }