Jump to

• Request
• Response
• Examples

Get one coverage applicability

get

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

Request

Path Parameters

• CoverageApplicabilityId(required): integer(int64)
  Primary key for the coverage applicability business object.
• CoverageId(required): integer(int64)
  Primary key for the asset warranty coverage business object. The application creates this value. This attribute is read-only.

Query Parameters

• dependency: string
  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>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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

• 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.

Body ()

Root Schema : assetWarrantyCoverages-coverageApplicabilities-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Title: Active End Date

  Read Only: true

  Value that specifies the end date for the coverage applicability.
• AutoAssignFlag: boolean
  Title: Autoassign

  Maximum Length: 1

  Default Value: true

  Value indicating that the warranty can be automatically created and assigned to this coverage.
• ContractDefaultStatus: string
  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.
• ContractDefaultStatusCode: string
  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.
• CoverageApplicabilityId: integer (int64)
  Title: Coverage Applicability ID

  Read Only: true

  Primary key for the coverage applicability business object.
• CoverageId: integer (int64)
  Title: Coverage ID

  Read Only: true

  Value that uniquely identifies the coverage to which the applicability belongs.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Column for identifying the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Column that identifies the date and time of creation of the row.
• DisabledFlag: boolean
  Title: Disabled Indicator

  Maximum Length: 80

  Value that specifies if the applicability is ineffective for the coverage.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description for the item for which the coverage is applicable.
• ItemId: integer (int64)
  Title: Item ID

  Value that identifies the item for which the coverage is applicable.
• ItemLongDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000

  Long description for the item for which the coverage is applicable.
• ItemNumber: string
  Title: Item Number

  Maximum Length: 255

  Value that identifies the item number for which the coverage is applicable.
• ItemOrganizationCode: string
  Title: Item Organization Code

  Maximum Length: 255

  Value that identifies the organization to which item is applicable for this coverage.
• ItemOrganizationId: integer (int64)
  Title: Item Organization ID

  Value that identifies the covered organization.
• ItemOrganizationName: string
  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.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Column that identifies the date and time of the last update on the row.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Column that identifies the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SupplierId: integer (int64)
  Title: Supplier ID

  Value that uniquely identifies the supplier ID.
• SupplierName: string
  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.
• SupplierNumber: string
  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.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Value that specifies the end date for the coverage applicability.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AutoAssignFlag":{
            "title":"Autoassign",
            "maxLength":1,
            "type":"boolean",
            "description":"Value indicating that the warranty can be automatically created and assigned to this coverage.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContractDefaultStatus":{
            "title":"Contract Default Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning for the Contract default status code that can be assigned to the contract when the contract is auto created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractDefaultStatusCode":{
            "title":"Contract Default Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Value that specifies the default status code that can be assigned to the contract when the contract is auto created.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageApplicabilityId":{
            "title":"Coverage Applicability ID",
            "type":"integer",
            "description":"Primary key for the coverage applicability business object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"Value that uniquely identifies the coverage to which the applicability belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Column for identifying the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Column that identifies the date and time of creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":80,
            "type":"boolean",
            "description":"Value that specifies if the applicability is ineffective for the coverage.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description for the item for which the coverage is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that identifies the item for which the coverage is applicable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemLongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"Long description for the item for which the coverage is applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the item number for which the coverage is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemOrganizationCode":{
            "title":"Item Organization Code",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the organization to which item is applicable for this coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "title":"Item Organization ID",
            "type":"integer",
            "description":"Value that identifies the covered organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemOrganizationName":{
            "title":"Item Organization Name",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the organization name to which the item is applicable for this coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Column that identifies the date and time of the last update on the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Column that identifies the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier Name",
            "maxLength":360,
            "type":"string",
            "description":"Value that identifies the supplier name which is optionally used in matching the receipts for making the item applicable for the coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the supplier number which is optionally used in matching the receipts for making the item applicable for the coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

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