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

95 lines
4.7 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"wsdl_segment",
"field_reference"
],
"title": "WorkOrderShare - Data API",
"description": "Represents a sharing entry on a work order. This object is available in API version 36.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"AccessLevel": {
"type": "picklist",
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
"description": "Level of access that the user or group has to the work order. The possible values are: Read Edit All (This value isnt valid for create or update calls.) Set to an access level that is at least equal to the organizations default work order access level."
},
"ParentId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The work order associated with the sharing entry. This is a relationship field.",
"relationship_name": "Parent",
"relationship_type": "Lookup",
"refers_to": "WorkOrder"
},
"RowCause": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Reason that this sharing entry exists. If youre creating a sharing entry, the only permitted value is Manual. If no value is specified, the field defaults to Manual. All other RowCause values are read-only. After the sharing entry is created, this field cant be edited. Valid values include: Manual—The User or Group has access because a user with “All” access manually shared the work order. Owner—The User is the owner of the work order. Rule—The User or Group has access via a work order sharing rule. GuestRule—The User or Group has access via a work order guest user sharing rule. LpuImplicit—The User has access to records owned by high-volume Experience Cloud site users via a share group."
},
"UserOrGroupId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "(Read Only) ID of the user or group that has access to the work order. This is a polymorphic relationship field.",
"relationship_name": "UserOrGroup",
"relationship_type": "Lookup",
"refers_to": "Group, User"
}
},
"special_access_rules": "Work orders or Field Service must be enabled in your organization. External users cant access this object.",
"wsdl_segment": "```xml\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<complexType name=\"WorkOrderShare\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"AccessLevel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Parent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:WorkOrder\"/>\n <element name=\"ParentId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"RowCause\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"UserOrGroup\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"UserOrGroupId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
"field_reference": {
"AccessLevel": {
"field_label": "Custom Object Access",
"type": "picklist",
"length": "40"
},
"Id": {
"field_label": "Custom Object Share ID",
"type": "id",
"length": "18"
},
"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"
},
"ParentId": {
"field_label": "Parent ID",
"type": "reference",
"length": "18"
},
"RowCause": {
"field_label": "Row Cause",
"type": "picklist",
"length": "40"
},
"UserOrGroupId": {
"field_label": "User/Group ID",
"type": "reference",
"length": "18"
}
},
"field_reference_columns": [
"field_label",
"type",
"length"
]
}