afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/TimeSheetTemplate.json

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "special_access_rules",
    "wsdl_segment"
  ],
  "title": "TimeSheetTemplate - Tooling API",
  "description": "Represents a template for creating time sheets in Field Service. Available in API version 46.0 and later.",
  "supported_soap_calls": "`create()`, `delete()`, `describeLayout()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`GET`, `POST`, `PATCH`, `DELETE`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "Active": {
      "type": "boolean",
      "properties": "Defaulted On Create, Filter, Group, Sort",
      "description": "Indicates whether the time sheet template is active (true) or not (false)."
    },
    "Description": {
      "type": "textarea",
      "properties": "Nillable",
      "description": "The time sheet template's description."
    },
    "DeveloperName": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The API name of the time sheet template. Can contain alphanumeric characters and underscores, and must begin with a letter. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "Frequency": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "Defines the frequency of the time sheet creation period. One of the following values: Daily Weekly EveryTwoWeeks TwiceAMonth Monthly"
    },
    "Fullname": {
      "type": "string",
      "properties": "Create, Group, Nillable",
      "description": "The full name of the associated metadata object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
    },
    "Language": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The language associated with the time sheet template."
    },
    "ManageableState": {
      "type": "ManageableState enumerated list",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates the manageable state of the specified component that is contained in a package: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
    },
    "MasterLabel": {
      "type": "string",
      "properties": "Filter, Group, Sort",
      "description": "The name of the time sheet template."
    },
    "Metadata": {
      "type": "mns:TimeSheetTemplate",
      "properties": "Create, Nillable, Update",
      "description": "The TimeSheetTemplate metadata."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace that identifies the package that manages the time sheet template. Available in API version 48.0 and later."
    },
    "StartDate": {
      "type": "date",
      "properties": "Filter, Group, Sort",
      "description": "The date when the time sheet takes effect."
    },
    "TimeSheetTemplateAssignments": {
      "type": "QueryResult",
      "properties": "Nillable",
      "description": "A list of profiles that the template is assigned to. This field is only visible when the template has been assigned to at least one user profile. Available in API version 48.0 and later."
    },
    "WorkWeekEndDay": {
      "type": "picklist",
      "properties": "Defaulted On Create, Filter, Group, Restricted picklist, Sort",
      "description": "The end day of the template's work week. One of the following values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday (default)"
    },
    "WorkWeekStartDay": {
      "type": "picklist",
      "properties": "Defaulted On Create, Filter, Group, Restricted picklist, Sort",
      "description": "The start day of the template's work week. One of the following values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday (default)"
    }
  },
  "special_access_rules": "Field Service must be enabled to access TimeSheetTemplate. Users must have the Customize Application and Time Sheet Template permissions.",
  "wsdl_segment": "```xml\n<xsd:simpleType name=\"DaysOfWeek\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Sunday\"/>\n    <xsd:enumeration value=\"Monday\"/>\n    <xsd:enumeration value=\"Tuesday\"/>\n    <xsd:enumeration value=\"Wednesday\"/>\n    <xsd:enumeration value=\"Thursday\"/>\n    <xsd:enumeration value=\"Friday\"/>\n    <xsd:enumeration value=\"Saturday\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"TimeSheetFrequency\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"Daily\"/>\n    <xsd:enumeration value=\"Weekly\"/>\n    <xsd:enumeration value=\"EveryTwoWeeks\"/>\n    <xsd:enumeration value=\"TwiceAMonth\"/>\n    <xsd:enumeration value=\"Monthly\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"TimeSheetTemplate\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:TimeSheetTemplate\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"TimeSheetTemplate\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"active\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"frequency\" type=\"tns:TimeSheetFrequency\"/>\n        <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n        <xsd:element name=\"startDate\" type=\"xsd:date\"/>\n        <xsd:element name=\"timeSheetTemplateAssignments\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"mns:TimeSheetTemplateAssignment\"/>\n        <xsd:element name=\"workWeekEndDay\" type=\"tns:DaysOfWeek\"/>\n        <xsd:element name=\"workWeekStartDay\" type=\"tns:DaysOfWeek\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```"
}