Jump to

• Request
• Response

Get an adjustment

get

/crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}/child/CoverageChargeDiscounts/{CoverageDiscountPuid}

Request

Path Parameters

• CoverageDiscountPuid(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• CoverageHeaderPuid(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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:
  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 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-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.
• ChargeDiscountId: integer (int64)
  The unique identifier of the adjustment.
• 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.
• 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.
• PricingBasisId: integer
  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.
• StartDate: string (date)
  Title: Start Date

  The date when the adjustment starts.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the adjustment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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
        },
        "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
        },
        "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
        },
        "ChargeDiscountId":{
            "type":"integer",
            "description":"The unique identifier of the adjustment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PricingBasisId":{
            "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
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the adjustment starts.",
            "format":"date",
            "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
        },
        "AdjustmentAmount":{
            "title":"Value",
            "type":"number",
            "description":"The amount entered for an adjustment type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageDiscountPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The value that uniquely identifies the adjustments.",
            "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
        },
        "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
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the coverage adjustment ends.",
            "format":"date",
            "nullable":true,
            "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "PricingTermId":{
            "type":"integer",
            "description":"The unique identifier of the pricing term.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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