Standard Coverages
subscriptionCoverageHeaders Based on latest (2026.09)
Create, change, delete and look up Standard Coverages, with coverage charge discounts and preventive maintenance work requirements.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
CoverageHeaderPuid- Required on create
CoverageDescriptionDynamicMatrixClassIdStartDate- At a glance
- 24 fields2 finders2 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders?fields=CoverageDescription,CoverageHeaderId,CoverageHeaderPuid,CoverageName,CreatedBy&limit=25&onlyData=true
{
"items": [
{
"CoverageDescription": "<string, max 1000>",
"CoverageHeaderId": 0,
"CoverageHeaderPuid": "<string, max 120>",
"CoverageName": "<string, max 150>",
"CreatedBy": "<string, max 64>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 24
| Attribute | Type | Use |
|---|---|---|
CoverageDescription | text · max 1000 | Required on createUpdatableSearchable |
CoverageHeaderId | number | Optional on createSearchable |
CoverageHeaderPuid | text · max 120 | Optional on createSearchable |
CoverageName | text · max 150 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
DynamicMatrixClassId | number | Required on createSearchable |
DynamicMatrixClassName | text | Optional on createUpdatableSearchable |
EndDate | date | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
MatrixId | number | Optional on createUpdatableSearchable |
MatrixName | text | Optional on createUpdatableSearchable |
ProgramCode | text · max 30 | Optional on createUpdatableSearchable |
ProgramDescription | text · max 240 | Read-onlySearchable |
ProgramEndDate | date | Read-onlySearchable |
ProgramId | number | Optional on createUpdatableSearchable |
ProgramName | text · max 120 | Optional on createUpdatableSearchable |
ProgramOrganizationId | number | Optional on createUpdatableSearchable |
ProgramStartDate | date | Read-onlySearchable |
StandardCoverageYn | text · max 1 | Optional on createUpdatableSearchable |
StartDate | date | Required on createUpdatableSearchable |
SubscriptionProductPuid | text | Optional on createUpdatable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
PuidAltKey·CoverageHeaderPuidcoverageHeaderRowFinder·varSysDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 2
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/subscriptionCoverageHeaders/{CoverageHeaderPuid}/child/<name>. Add them to a GET with expand.
CoverageChargeDiscountsGET · POST · PATCH Adjustments · 36 fields · 1 findersAdjustmentAmountAdjustmentTypeCodeAdjustmentTypeMeaningAllowCustomAdjustmentsFlagAllowPricingDiscountsFlagBillingTypeCodeBillingTypeMeaningBusinessProcessCodeBusinessProcessMeaningChargeDefinitionCodeChargeDefinitionIdChargeDefinitionNameChargeDiscountIdChargeSubtypeCodeChargeTypeCodeCoverageDiscountPuidCoverageHeaderIdCoverageHeaderPuidCreatedByCreationDateCurrencyCodeEndDateLastUpdateDateLastUpdateLoginLastUpdatedByOrganizationIdPriceUOMPriceUOMCodePricingBasisIdPricingBasisNamePricingTermIdServiceActivityIdServiceActivityNameServiceItemIdServiceItemNumberStartDatePreventiveMaintenanceWorkRequirementsGET Preventive Maintenance Work Requirements · 14 fieldsActiveEndDateActiveStartDateAssetInclusionTypeCodeItemIdItemNameItemNumberOrganizationIdProgramIdRequirementIdRequirementNameRequirementTypeRequirementTypeCodeStatusStatusCode
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/subscriptionCoverageHeadersand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
PuidAltKeyfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CoverageDescription, notcoveragedescription. - 8 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.