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

181 lines
11 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "TimeSheet - Data API",
"description": "Represents a schedule of a service resources time in Field Service or Workforce Engagement. This object is available in API v47.0 and later.",
"fields_columns": [
"type",
"properties",
"description"
],
"fields": {
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. The label in the user interface is Currency ISO Code."
},
"EndDate": {
"type": "date",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The last day the time sheet covers."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last interacted with this record, directly or indirectly."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The owner of the time sheet."
},
"ServiceResourceId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The service resource whose time is being tracked with the time sheet."
},
"StartDate": {
"type": "date",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The first day the time sheet covers."
},
"Status": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Sort, Update",
"description": "The status of the time sheet. The picklist includes the following values, which can be customized: New Submitted Approved"
},
"TimeSheetEntryCount": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "(Read Only) The number of related time sheet entries."
},
"TimeSheetNumber": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "An auto-generated number identifying the time sheet."
},
"TotalDurationInHours": {
"type": "double",
"properties": "Filter, Nillable, Sort",
"description": "Represents the sum total of the duration field of all the time sheet entries related to the time sheet object in hours."
},
"TotalDurationInMinutes": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "Represents the sum total of the duration field of all the time sheet entries related to the time sheet object in minutes."
}
},
"special_access_rules": "Field Service or Workforce Engagement must be enabled.",
"associated_objects": "This object has the following associated objects. Unless noted, they are available in the same API version as this object.\n\n- **TimeSheetChangeEvent (API version 48.0)**: Change events are available for the object.\n- **TimeSheetFeed**: Feed tracking is available for the object.\n- **TimeSheetHistory**: History is available for tracked fields of the object.\n- **TimeSheetOwnerSharingRule**: Sharing rules are available for the object.\n- **TimeSheetShare**: Sharing is available for the 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<simpleType name=\"QueryLocator\">\n <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n <sequence>\n <element name=\"done\" type=\"xsd:boolean\"/>\n <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n <element name=\"size\" type=\"xsd:int\"/>\n </sequence>\n</complexType>\n<complexType name=\"TimeSheet\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ActivityHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"DynamicDataCaptures\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"EndDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:date\"/>\n <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"RecordActionHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"RecordActions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ServiceResource\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ServiceResource\"/>\n <element name=\"ServiceResourceId\" nillable=\"true\" minOccurs=\"0\" type=
"field_reference": {
"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"
},
"EndDate": {
"field_label": "Time Sheet End Date",
"type": "date"
},
"Id": {
"field_label": "Time Sheet 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"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"ServiceResourceId": {
"field_label": "Resource ID",
"type": "reference",
"length": "18"
},
"StartDate": {
"field_label": "Time Sheet Start Date",
"type": "date"
},
"Status": {
"field_label": "Status",
"type": "picklist",
"length": "40"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"TimeSheetEntryCount": {
"field_label": "Time Sheet Entry Count",
"type": "int",
"digits": "9"
},
"TimeSheetNumber": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"TotalDurationInHours": {
"field_label": "Total Duration (In Hours)",
"type": "double",
"precision": "18",
"scale": "2"
},
"TotalDurationInMinutes": {
"field_label": "Total Duration (In Minutes)",
"type": "int",
"digits": "9"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits",
"precision",
"scale"
]
}