afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/CommerceEntitlementPolicy.json

144 lines
4.9 KiB
JSON

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"field_reference"
],
"title": "CommerceEntitlementPolicy - Data API",
"description": "Represents an entitlement policy, which determines what products and prices a user can see. This object is available in API version 49.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"CanViewPrice": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Determines whether a user can view the price of a product (true) or not (false). Default value is false."
},
"CanViewProduct": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Determines whether a user can view the product (true) or not (false). Default value is false."
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The standard code for the currency. Possible values are: GBP—British Pound USD—U.S. Dollar"
},
"Description": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The entitlement policy description."
},
"IsActive": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Determines if the entitlement policy is active (true) or inactive (false). Default value is false."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed a record related to this record."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp for when the current user last viewed this record. If this value is null, it can mean that the record was only referenced (LastReferencedDate) and not viewed."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of the entitlement policy."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The unique ID for the entitlement policy owner."
}
},
"special_access_rules": "The CommerceEntitlementPolicy object is available only if the B2B Commerce license is enabled.",
"associated_objects": "This object has the following associated objects. Except where noted, these objects are available in the same API version as CommerceEntitlementPolicy.\n\n- **CommerceEntitlementPolicyChangeEvent**: Change events are available for the object.\n- **CommerceEntitlementPolicyOwnerFeed**: Feed tracking is available for the object.\n- **CommerceEntitlementPolicyHistory**: History is available for tracked fields of the object.\n- **CommerceEntitlementPolicyOwnerSharingRule**: Sharing rules are available for this object.",
"field_reference": {
"CanViewPrice": {
"field_label": "View prices in catalog",
"type": "boolean"
},
"CanViewProduct": {
"field_label": "View products",
"type": "boolean"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"Description": {
"field_label": "Description",
"type": "string",
"length": "255"
},
"Id": {
"field_label": "Entitlement Policy ID",
"type": "id",
"length": "18"
},
"IsActive": {
"field_label": "Active",
"type": "boolean"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}