Get one coverage applicability

get

/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageApplicabilities/{CoverageApplicabilityId}

Request

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

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

    Format: ?fields=Attribute1,Attribute2

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

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : assetWarrantyCoverages-coverageApplicabilities-item-response
Type: object
Show Source
  • Title: Active End Date
    Read Only: true
    Value that specifies the end date for the coverage applicability.
  • Title: Autoassign
    Maximum Length: 1
    Default Value: true
    Value indicating that the warranty can be automatically created and assigned to this coverage.
  • Title: Contract Default Status
    Read Only: true
    Maximum Length: 80
    Meaning for the Contract default status code that can be assigned to the contract when the contract is auto created.
  • Title: Contract Default Status Code
    Maximum Length: 30
    Value that specifies the default status code that can be assigned to the contract when the contract is auto created.
  • Title: Coverage Applicability ID
    Read Only: true
    Primary key for the coverage applicability business object.
  • Title: Coverage ID
    Read Only: true
    Value that uniquely identifies the coverage to which the applicability belongs.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Column for identifying the user who created the row.
  • Title: Creation Date
    Read Only: true
    Column that identifies the date and time of creation of the row.
  • Title: Disabled Indicator
    Maximum Length: 80
    Value that specifies if the applicability is ineffective for the coverage.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description for the item for which the coverage is applicable.
  • Title: Item ID
    Value that identifies the item for which the coverage is applicable.
  • Title: Long Description
    Read Only: true
    Maximum Length: 4000
    Long description for the item for which the coverage is applicable.
  • Title: Item Number
    Maximum Length: 255
    Value that identifies the item number for which the coverage is applicable.
  • Title: Item Organization Code
    Maximum Length: 255
    Value that identifies the organization to which item is applicable for this coverage.
  • Title: Item Organization ID
    Value that identifies the covered organization.
  • Title: Item Organization Name
    Read Only: true
    Maximum Length: 255
    Value that identifies the organization name to which the item is applicable for this coverage.
  • Title: Last Update Date
    Read Only: true
    Column that identifies the date and time of the last update on the row.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Column that identifies the user who last updated the row.
  • Links
  • Title: Supplier ID
    Value that uniquely identifies the supplier ID.
  • Title: Supplier Name
    Read Only: true
    Maximum Length: 360
    Value that identifies the supplier name which is optionally used in matching the receipts for making the item applicable for the coverage.
  • Title: Supplier Number
    Maximum Length: 255
    Value that identifies the supplier number which is optionally used in matching the receipts for making the item applicable for the coverage.
Back to Top

Examples

This example describes how to get a coverage applicable item for a warranty coverage.

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/assetWarrantyCoverages/CoverageId/child/coverageApplicabilities/CoverageApplicabilityId"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "CoverageApplicabilityId": 300100568130763,
    "CoverageId": 300100568130739,
    "ItemId": 300100566813001,
    "ItemNumber": "ALM-MX-ITEM-001",
    "ItemDescription": "ALM-MX-ITEM-001-DESC",
    "ItemLongDescription": "ALM-MX-ITEM-001-DESC-LONG",
    "ItemOrganizationId": 300100113363336,
    "ItemOrganizationCode": "ORG1",
    "ItemOrganizationName": "Organization1",
    "SupplierId": 999992000322153,
    "SupplierNumber": "654321",
    "SupplierName": "Supplier1",
    "AutoAssignFlag": false,
    "ContractDefaultStatusCode": "ORA_DRAFT",
    "ContractDefaultStatus": "Draft",
    "DisabledFlag": false,
    "ActiveEndDate": null,
    "CreatedBy": "USER",
    "CreationDate": "2022-10-28T14:48:10+00:00",
    "LastUpdatedBy": "USER",
    "LastUpdateDate": "2022-10-28T14:48:10.001+00:00",
     "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763",
            "name": "coverageApplicabilities",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763",
            "name": "coverageApplicabilities",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739",
            "name": "assetWarrantyCoverages",
            "kind": "item"
        }
    ]
}
Back to Top