Jump to

• Request
• Response

Get all standard coverages

get

/crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders

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
  
  

  • PrimaryKey Finds the standard coverage that matches the primary key criteria specified.
    Finder Variables
    • CoverageHeaderId; integer; The unique identifier of the standard coverage.
  • PuidAltKey Finds the standard coverage that matches the alternate key criteria specified.
    Finder Variables
    • CoverageHeaderPuid; string; The unique identifier of the standard coverage PUID.
  • coverageHeaderRowFinder Finds a standard subscription coverage based on the system date provided.
    Finder Variables
    • varSysDate; string; The system date of the standard subscription coverage.
• 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:
  

  • CoverageDescription; string; The value that uniquely identifies the standard coverage description.
  • CoverageHeaderId; integer; The unique identifier of the internal standard coverage.
  • CoverageHeaderPuid; string; The value that uniquely identifies the standard coverage.
  • CoverageName; string; The name of the standard coverage.
  • CreatedBy; string; The user who created the standard coverage record.
  • CreationDate; string; The date when the standard coverage was created.
  • DynamicMatrixClassId; integer; The unique identifier of the dynamic matrix class.
  • DynamicMatrixClassName; string; The alternate value that uniquely identifies the dynamic matrix class.
  • EndDate; string; The date when the standard coverage ends.
  • LastUpdateDate; string; The date when the standard coverage was last updated.
  • LastUpdateLogin; string; The name of the user who has last updated the standard coverage.
  • LastUpdatedBy; string; The user who last updated the standard coverage.
  • MatrixId; integer; The unique identifier of the dynamic matrix.
  • MatrixName; string; The name of the matrix.
  • ProgramCode; string; The code of the associated maintenance program.
  • ProgramDescription; string; The description of the associated maintenance program.
  • ProgramEndDate; string; The end date of the associated maintenance program.
  • ProgramId; integer; The identifier of the associated maintenance program.
  • ProgramName; string; The name of the associated maintenance program.
  • ProgramOrganizationId; integer; The organization identifier of the associated maintenance program.
  • ProgramStartDate; string; The start date of the associated maintenance program.
  • StandardCoverageYn; string; Indicates whether coverage is standard coverage. The default value is False.
  • StartDate; string; The date when the adjustments was created.
• 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: 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 : subscriptionCoverageHeaders

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/subscriptionCoverageHeaders-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object subscriptionCoverageHeaders-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/subscriptionCoverageHeaders-item-response"
    }
}

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 : subscriptionCoverageHeaders-item-response

Type: object

Show Source

• CoverageChargeDiscounts: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.
• CoverageDescription: string
  Title: Template Description

  Maximum Length: 1000

  The value that uniquely identifies the standard coverage description.
• CoverageHeaderId: integer (int64)
  The unique identifier of the internal standard coverage.
• CoverageHeaderPuid: string
  Maximum Length: 120

  The value that uniquely identifies the standard coverage.
• CoverageName: string
  Title: Template Name

  Maximum Length: 150

  The name of the standard coverage.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the standard coverage record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the standard coverage was created.
• DynamicMatrixClassId: integer (int64)
  Title: Entitlement Type

  The unique identifier of the dynamic matrix class.
• DynamicMatrixClassName: string
  Title: Entitlement Type

  The alternate value that uniquely identifies the dynamic matrix class.
• EndDate: string (date)
  Title: End Date

  The date when the standard coverage ends.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the standard coverage was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the standard coverage.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The name of the user who has last updated the standard coverage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixId: integer (int64)
  The unique identifier of the dynamic matrix.
• MatrixName: string
  The name of the matrix.
• PreventiveMaintenanceWorkRequirements: array Preventive Maintenance Work Requirements
  Title: Preventive Maintenance Work Requirements

  The preventive maintenance work requirements resource is used to get the work requirements of a preventive maintenance program associated with a subscription coverage.
• ProgramCode: string
  Title: Program Code

  Maximum Length: 30

  The code of the associated maintenance program.
• ProgramDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the associated maintenance program.
• ProgramEndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the associated maintenance program.
• ProgramId: integer (int64)
  The identifier of the associated maintenance program.
• ProgramName: string
  Title: Program Name

  Maximum Length: 120

  The name of the associated maintenance program.
• ProgramOrganizationId: integer (int64)
  Title: Organization

  The organization identifier of the associated maintenance program.
• ProgramStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the associated maintenance program.
• StandardCoverageYn: string
  Maximum Length: 1

  Indicates whether coverage is standard coverage. The default value is False.
• StartDate: string (date)
  Title: Start Date

  The date when the adjustments was created.
• SubscriptionProductPuid: string
  The value that uniquely identifies the subscription product.

{
    "type":"object",
    "properties":{
        "CoverageChargeDiscounts":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.",
            "items":{
                "$ref":"#/components/schemas/subscriptionCoverageHeaders-CoverageChargeDiscounts-item-response"
            }
        },
        "CoverageDescription":{
            "title":"Template Description",
            "maxLength":1000,
            "type":"string",
            "description":"The value that uniquely identifies the standard coverage description.",
            "nullable":false,
            "x-queryable":true
        },
        "CoverageHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the internal standard coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoverageHeaderPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The value that uniquely identifies the standard coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageName":{
            "title":"Template Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the standard coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the standard coverage record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the standard coverage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicMatrixClassId":{
            "title":"Entitlement Type",
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix class.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DynamicMatrixClassName":{
            "title":"Entitlement Type",
            "type":"string",
            "description":"The alternate value that uniquely identifies the dynamic matrix class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the standard coverage ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the standard coverage was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The name of the user who has last updated the standard coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the standard coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MatrixName":{
            "type":"string",
            "description":"The name of the matrix.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreventiveMaintenanceWorkRequirements":{
            "title":"Preventive Maintenance Work Requirements",
            "type":"array",
            "description":"The preventive maintenance work requirements resource is used to get the work requirements of a preventive maintenance program associated with a subscription coverage.",
            "items":{
                "$ref":"#/components/schemas/subscriptionCoverageHeaders-PreventiveMaintenanceWorkRequirements-item-response"
            }
        },
        "ProgramCode":{
            "title":"Program Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the associated maintenance program.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the associated maintenance program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the associated maintenance program.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"The identifier of the associated maintenance program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":120,
            "type":"string",
            "description":"The name of the associated maintenance program.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "ProgramOrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The organization identifier of the associated maintenance program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ProgramStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the associated maintenance program.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardCoverageYn":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether coverage is standard coverage. The default value is False.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the adjustments was created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "type":"string",
            "description":"The value that uniquely identifies the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Adjustments

Type: array

Title: Adjustments

The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.

Show Source

• Array of: object subscriptionCoverageHeaders-CoverageChargeDiscounts-item-response

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.",
    "items":{
        "$ref":"#/components/schemas/subscriptionCoverageHeaders-CoverageChargeDiscounts-item-response"
    }
}

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 : Preventive Maintenance Work Requirements

Type: array

Title: Preventive Maintenance Work Requirements

The preventive maintenance work requirements resource is used to get the work requirements of a preventive maintenance program associated with a subscription coverage.

Show Source

• Array of: object subscriptionCoverageHeaders-PreventiveMaintenanceWorkRequirements-item-response

{
    "title":"Preventive Maintenance Work Requirements",
    "type":"array",
    "description":"The preventive maintenance work requirements resource is used to get the work requirements of a preventive maintenance program associated with a subscription coverage.",
    "items":{
        "$ref":"#/components/schemas/subscriptionCoverageHeaders-PreventiveMaintenanceWorkRequirements-item-response"
    }
}

Nested Schema : subscriptionCoverageHeaders-CoverageChargeDiscounts-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Title: Value

  The amount entered for an adjustment type.
• AdjustmentTypeCode: string
  Maximum Length: 30

  The unique code for adjustment type lookup. Valid values include discount percent or markup percent. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
• AdjustmentTypeMeaning: string
  Title: Adjustment Type

  The display value for the adjustment type lookup. The alternate valid values include discount percent or markup percent. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.
• AllowCustomAdjustmentsFlag: boolean
  Title: Allow custom adjustments

  Maximum Length: 1

  Indicates whether custom adjustments are allowed. The Default value is True.
• AllowPricingDiscountsFlag: boolean
  Title: Allow pricing discounts

  Maximum Length: 1

  Indicates whether pricing discounts are allowed. The default value is False.
• BillingTypeCode: string
  Maximum Length: 30

  The unique code for billing type lookup. A list of accepted values is defined in the lookup type EGP_MATERIAL_BILLABLE_TYPE for billing type code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• BillingTypeMeaning: string
  Title: Billing Type

  The display value for the billing type lookup code. A list of accepted values is defined in the lookup type EGP_MATERIAL_BILLABLE_TYPE for billing type meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• BusinessProcessCode: string
  Maximum Length: 30

  The unique code for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• BusinessProcessMeaning: string
  Title: Business Process

  The display value for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• ChargeDefinitionCode: string
  Maximum Length: 30

  The charge definition code.
• ChargeDefinitionId: integer (int64)
  Title: Charge Definition

  The charge definition identifier.
• ChargeDefinitionName: string
  Title: Charge Definition

  Maximum Length: 255

  The charge definition name.
• ChargeDiscountId: integer (int64)
  The unique identifier of the adjustment.
• ChargeSubtypeCode: string
  Maximum Length: 30

  The charge subtype code.
• ChargeTypeCode: string
  Maximum Length: 30

  The charge type code.
• CoverageDiscountPuid: string
  Maximum Length: 120

  The value that uniquely identifies the adjustments.
• CoverageHeaderId: integer (int64)
  The unique identifier of the parent coverage header against an adjustment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the adjustment.
• CreationDate: string (date-time)
  Read Only: true

  The date when the adjustment was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code.
• EndDate: string (date)
  Title: End Date

  The date when the coverage adjustment ends.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the adjustment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the adjustment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The name of the user who has last updated the adjustment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  The organization ID.
• PriceUOM: string
  Title: Price UOM

  Maximum Length: 255

  The price UOM.
• PriceUOMCode: string
  Title: Price UOM

  Maximum Length: 3

  The price UOM code.
• PricingBasisId: integer
  Title: Adjustment Basis

  The unique identifier of the pricing basis. A list of accepted values is defined in the view qp_pricing_basis_vl for pricing basis ID.
• PricingBasisName: string
  Title: Adjustment Basis

  The name of the pricing basis. A list of accepted values is defined in the view qp_pricing_basis_vl for pricing basis name.
• PricingTermId: integer
  The unique identifier of the pricing term.
• ServiceActivityId: integer (int64)
  The unique identifier of the service activity. A list of accepted values is defined in the view RCL_SERVICE_ACTIVITIES_VL for service activity ID.
• ServiceActivityName: string
  Title: Service Activity

  Maximum Length: 80

  The name of the service activity. A list of accepted values is defined in the view RCL_SERVICE_ACTIVITIES_VL for service activity name.
• ServiceItemId: integer (int64)
  Title: Service Item

  The service item ID.
• ServiceItemNumber: string
  Title: Service Item

  Maximum Length: 255

  The service item number.
• StartDate: string (date)
  Title: Start Date

  The date when the adjustment starts.

{
    "type":"object",
    "properties":{
        "AdjustmentAmount":{
            "title":"Value",
            "type":"number",
            "description":"The amount entered for an adjustment type.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code for adjustment type lookup. Valid values include discount percent or markup percent. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.",
            "nullable":false,
            "x-queryable":true
        },
        "AdjustmentTypeMeaning":{
            "title":"Adjustment Type",
            "type":"string",
            "description":"The display value for the adjustment type lookup. The alternate valid values include discount percent or markup percent. A list of accepted values is defined in the lookup type ORA_QP_LINE_ADJ_TYPES.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AllowCustomAdjustmentsFlag":{
            "title":"Allow custom adjustments",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether custom adjustments are allowed. The Default value is True.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowPricingDiscountsFlag":{
            "title":"Allow pricing discounts",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether pricing discounts are allowed. The default value is False.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code for billing type lookup. A list of accepted values is defined in the lookup type EGP_MATERIAL_BILLABLE_TYPE for billing type code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingTypeMeaning":{
            "title":"Billing Type",
            "type":"string",
            "description":"The display value for the billing type lookup code. A list of accepted values is defined in the lookup type EGP_MATERIAL_BILLABLE_TYPE for billing type meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "BusinessProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessProcessMeaning":{
            "title":"Business Process",
            "type":"string",
            "description":"The display value for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge definition code.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeDefinitionId":{
            "title":"Charge Definition",
            "type":"integer",
            "description":"The charge definition identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "title":"Charge Definition",
            "maxLength":255,
            "type":"string",
            "description":"The charge definition name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ChargeDiscountId":{
            "type":"integer",
            "description":"The unique identifier of the adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeSubtypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge subtype code.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The charge type code.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageDiscountPuid":{
            "maxLength":120,
            "type":"string",
            "description":"The value that uniquely identifies the adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the parent coverage header against an adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the coverage adjustment ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the adjustment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The name of the user who has last updated the adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The organization ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceUOM":{
            "title":"Price UOM",
            "maxLength":255,
            "type":"string",
            "description":"The price UOM.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PriceUOMCode":{
            "title":"Price UOM",
            "maxLength":3,
            "type":"string",
            "description":"The price UOM code.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"The unique identifier of the pricing basis. A list of accepted values is defined in the view qp_pricing_basis_vl for pricing basis ID.",
            "nullable":true,
            "x-queryable":true
        },
        "PricingBasisName":{
            "title":"Adjustment Basis",
            "type":"string",
            "description":"The name of the pricing basis. A list of accepted values is defined in the view qp_pricing_basis_vl for pricing basis name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingTermId":{
            "type":"integer",
            "description":"The unique identifier of the pricing term.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceActivityId":{
            "type":"integer",
            "description":"The unique identifier of the service activity. A list of accepted values is defined in the view RCL_SERVICE_ACTIVITIES_VL for service activity ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceActivityName":{
            "title":"Service Activity",
            "maxLength":80,
            "type":"string",
            "description":"The name of the service activity. A list of accepted values is defined in the view RCL_SERVICE_ACTIVITIES_VL for service activity name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ServiceItemId":{
            "title":"Service Item",
            "type":"integer",
            "description":"The service item ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceItemNumber":{
            "title":"Service Item",
            "maxLength":255,
            "type":"string",
            "description":"The service item number.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the adjustment starts.",
            "format":"date",
            "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."
        }
    }
}

Nested Schema : subscriptionCoverageHeaders-PreventiveMaintenanceWorkRequirements-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Title: End Date

  Read Only: true

  Start Date
• ActiveStartDate: string (date)
  Title: Start Date

  Read Only: true

  End Date
• AssetInclusionTypeCode: string
  Read Only: true

  Maximum Length: 30

  The asset inclusion type code associated with a work requirement.
• ItemId: integer (int64)
  Title: Related Inventory Item ID

  Read Only: true

  Related Inventory Item ID
• ItemName: string
  Title: Item

  Read Only: true

  Maximum Length: 240

  Item
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  The number of the item associated with a work requirement.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Title: Organization

  Read Only: true

  Organization
• ProgramId: integer (int64)
  Read Only: true

  The identifier of the program associated with the work requirement.
• RequirementId: integer
  Read Only: true

  The unique identifier of the work requirement.
• RequirementName: string
  Title: Name

  Read Only: true

  Maximum Length: 120

  Name
• RequirementType: string
  Read Only: true

  Maximum Length: 80

  The type of the work requirement.
• RequirementTypeCode: string
  Read Only: true

  Maximum Length: 30

  The type code of the work requirement.
• Status: string
  Title: Line Status

  Read Only: true

  Maximum Length: 80

  Line Status
• StatusCode: string
  Title: Line Status

  Read Only: true

  Maximum Length: 30

  Line Status

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetInclusionTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The asset inclusion type code associated with a work requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Related Inventory Item ID",
            "type":"integer",
            "description":"Related Inventory Item ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item",
            "maxLength":240,
            "type":"string",
            "description":"Item",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"The number of the item associated with a work requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"Organization",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"The identifier of the program associated with the work requirement.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequirementId":{
            "type":"integer",
            "description":"The unique identifier of the work requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"Name",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementType":{
            "maxLength":80,
            "type":"string",
            "description":"The type of the work requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type code of the work requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Line Status",
            "maxLength":80,
            "type":"string",
            "description":"Line Status",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Line Status",
            "maxLength":30,
            "type":"string",
            "description":"Line Status",
            "nullable":true,
            "readOnly":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"
    }
}

Back to Top