CustomFieldTemplates




Important note about API versions

If you are using Dovico Timesheet version 13 or below, you should use API version 5. If using version 14, use API version 6.



Versions 1 through 6
This call has been updated to reflect the 6th version of the API.
The API calls listed below enable a person to view Custom Field Templates.

Examples are provided using cURL.cURL is a 3rd party tool used for transferring data with URL syntax.



Get all Custom Field Templates for a specified type


GET CustomFieldTemplates/Type/{sType}/

Returns a list of all Custom Field Templates, for the specified type, using pagination.

Security Check: The user must have Software Access set to 'All' or 'Time and Expense Entry only'.

Example XML request:
 
        URI: https://api.dovico.com/CustomFieldTemplates/Type/{Type}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/CustomFieldTemplates/Type/E/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 

Fields for the URI
*Type (required - the type of custom field templates to return. Available types are: C (client), P (project), T (task), E (employee), A (expense category), G (group - teams), M (time entry), and X (expense entry))
LinkID query string (e.g. 'linkid={LinkID}' - optional - used when requesting Time or Expense Custom Field Templates. The LinkID value is the ID of the Task/Expense Cagtegory associated with the Time/Expense Entry)

Example JSON request:
 
        URI: https://api.dovico.com/CustomFieldTemplates/Type/{Type}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/CustomFieldTemplates/Type/E/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
Fields for the URI
*Type (required - the type of custom field templates to return. Available types are: C (client), P (project), T (task), E (employee), A (expense category), G (group - teams),M (time entry), and X (expense entry))
LinkID query string (e.g. 'linkid={LinkID}' - optional - used when requesting Time or Expense Custom Field Templates. The LinkID value is the ID of the Task/Expense Cagtegory associated with the Time/Expense Entry)
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <CustomTemplates>
                <CustomTemplate>
                    <ID>124</ID>
                    <Name>Date of Birth</Name>
                    <Type>D</Type>
                    <Required>T</Required>
                    <Description></Description>
                    <Hide>F</Hide>
                    <Values />
                </CustomTemplate>
                <CustomTemplate>
                    ...
                </CustomTemplate>
            </CustomTemplates>
            <PrevPageURI>https://api.dovico.com/CustomFieldTemplates/Type/E/?prev=124&version=6</PrevPageURI>
            <NextPageURI>https://api.dovico.com/CustomFieldTemplates/Type/E/?next=148&version=6</NextPageURI>
        </Result>
 
Fields for Result
CustomTemplates (will return zero or more CustomTemplate nodes)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for CustomTemplate
ID (long)
Name (string)
Type (string - Possible values are: A (alphanumeric), N (numeric), D (date), M (multiple choice), and X (exclusive choice))
Required (string - 'T' or 'F')
Description (string)
Hide (string - 'T' or 'F')
Values (zero or more Value nodes - will be zero if the Custom Field Template was not given a default value when dealing with Alphanumeric, Numeric, and Date custom field templates. Will contain one or more Value nodes for each item specified for the Multiple/Exclusive Choice custom field templates.)


Fields for Value
ID (long)
Value (string)
Default (string - 'T' or 'F')

Example JSON response:
 
        {
        "CustomTemplates":
            [
                {
                    "ID":"124",
                    "Name":"Date of Birth",
                    "Type":"D",
                    "Required":"T",
                    "Description":"",
                    "Hide":"F",
                    "Values":[]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/Type\/E\/?prev=124&version=6</PrevPageURI>
        "NextPageURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/Type\/E\/?next=148&version=6</NextPageURI>
        }
 
Fields
CustomTemplates (will return zero or more CustomTemplate objects)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for CustomTemplate
ID (long)
Name (string)
Type (string - Possible values are: A (alphanumeric), N (numeric), D (date), M (multiple choice), and X (exclusive choice))
Required (string - 'T' or 'F')
Description (string)
Hide (string - 'T' or 'F')
Values (zero or more Value objects - will be zero if the Custom Field Template was not given a default value when dealing with Alphanumeric, Numeric, and Date custom field templates. Will contain one or more Value objects for each item specified for the Multiple/Exclusive Choice custom field templates.)


Fields for Value
ID (long)
Value (string)
Default (string - 'T' or 'F')



Get a specific Custom Field Template


GET CustomFieldTemplates/{sCustomFieldTemplateID}/

Returns the requested Custom Field Template.

Security Check: The user must have Software Access set to 'All' or 'Time and Expense Entry only'.

Example XML request:
 
        URI: https://api.dovico.com/CustomFieldTemplates/{CustomFieldTemplateID}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/CustomFieldTemplates/131/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/CustomFieldTemplates/{CustomFieldTemplateID}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/CustomFieldTemplates/131/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <CustomTemplates>
                <CustomTemplate>
                    <ID>131</ID>
                    <Name>Department</Name>
                    <Type>X</Type>
                    <Required>T</Required>
                    <Description></Description>
                    <Hide>F</Hide>
                    <Values>
                        <Value>
                            <ID>129</ID>
                            <Value>Sales</Value>
                            <Default>F</Default>
                        </Value>
                        <Value>
                            <ID>130</ID>
                            <Value>Marketing</Value>
                            <Default>F</Default>
                        </Value>
                        <Value>
                            <ID>131</ID>
                            <Value>R&D</Value>
                            <Default>F</Default>
                        </Value>
                        <Value>
                            <ID>132</ID>
                            <Value>Human Resources</Value>
                            <Default>F</Default>
                        </Value>
                    </Values>
                </CustomTemplate>
            </CustomTemplates>
        </Result>
 
Fields for Result
CustomTemplates (will return zero CustomTemplate nodes if the requested item does not exist. Will return one CustomTemplate node if the requested item does exist)


Fields for CustomTemplate
ID (long)
Name (string)
Type (string - Possible values are: A (alphanumeric), N (numeric), D (date), M (multiple choice), and X (exclusive choice))
Required (string - 'T' or 'F')
Description (string)
Hide (string - 'T' or 'F')
Values (zero or more Value nodes - will be zero if the Custom Field Template was not given a default value when dealing with Alphanumeric, Numeric, and Date custom field templates. Will contain one or more Value nodes for each item specified for the Multiple/Exclusive Choice custom field templates.)


Fields for Value
ID (long)
Value (string)
Default (string - 'T' or 'F')
Example JSON response:
 
        {
        "CustomTemplates":
            [
                {
                    "ID":"131",
                    "Name":"Department",
                    "Type":"X",
                    "Required":"T",
                    "Description":"",
                    "Hide":"F",
                    "Values":
                        [
                            {
                                "ID":"129",
                                "Value":"Sales",
                                "Default":"F"
                            },
                            {
                                "ID":"130",
                                "Value":"Marketing",
                                "Default":"F"
                            },
                            {
                                "ID":"131",
                                "Value":"R&D",
                                "Default":"F"
                            },
                            {
                                "ID":"132",
                                "Value":"Human Resources",
                                "Default":"F"
                            }
                        ]
                }
            ]
        }
 
Fields
CustomTemplates (will return zero CustomTemplate objects if the requested item does not exist. Will return one CustomTemplate object if the requested item does exist)


Fields for CustomTemplate
ID (long)
Name (string)
Type (string - Possible values are: A (alphanumeric), N (numeric), D (date), M (multiple choice), and X (exclusive choice))
Required (string - 'T' or 'F')
Description (string)
Hide (string - 'T' or 'F')
Values (zero or more Value objects - will be zero if the Custom Field Template was not given a default value when dealing with Alphanumeric, Numeric, and Date custom field templates. Will contain one or more Value objects for each item specified for the Multiple/Exclusive Choice custom field templates.)


Fields for Value
ID (long)
Value (string)
Default (string - 'T' or 'F')