# infoplus.LoggedTimeApi All URIs are relative to *https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api* Method | HTTP request | Description ------------- | ------------- | ------------- [**addLoggedTimeAudit**](LoggedTimeApi.md#addLoggedTimeAudit) | **PUT** /beta/loggedTime/{loggedTimeId}/audit/{loggedTimeAudit} | Add new audit for a loggedTime [**addLoggedTimeFile**](LoggedTimeApi.md#addLoggedTimeFile) | **POST** /beta/loggedTime/{loggedTimeId}/file/{fileName} | Attach a file to a loggedTime [**addLoggedTimeFileByURL**](LoggedTimeApi.md#addLoggedTimeFileByURL) | **POST** /beta/loggedTime/{loggedTimeId}/file | Attach a file to a loggedTime by URL. [**addLoggedTimeTag**](LoggedTimeApi.md#addLoggedTimeTag) | **PUT** /beta/loggedTime/{loggedTimeId}/tag/{loggedTimeTag} | Add new tags for a loggedTime. [**deleteLoggedTimeFile**](LoggedTimeApi.md#deleteLoggedTimeFile) | **DELETE** /beta/loggedTime/{loggedTimeId}/file/{fileId} | Delete a file for a loggedTime. [**deleteLoggedTimeTag**](LoggedTimeApi.md#deleteLoggedTimeTag) | **DELETE** /beta/loggedTime/{loggedTimeId}/tag/{loggedTimeTag} | Delete a tag for a loggedTime. [**getDuplicateLoggedTimeById**](LoggedTimeApi.md#getDuplicateLoggedTimeById) | **GET** /beta/loggedTime/duplicate/{loggedTimeId} | Get a duplicated a loggedTime by id [**getLoggedTimeByFilter**](LoggedTimeApi.md#getLoggedTimeByFilter) | **GET** /beta/loggedTime/search | Search loggedTimes by filter [**getLoggedTimeById**](LoggedTimeApi.md#getLoggedTimeById) | **GET** /beta/loggedTime/{loggedTimeId} | Get a loggedTime by id [**getLoggedTimeFiles**](LoggedTimeApi.md#getLoggedTimeFiles) | **GET** /beta/loggedTime/{loggedTimeId}/file | Get the files for a loggedTime. [**getLoggedTimeTags**](LoggedTimeApi.md#getLoggedTimeTags) | **GET** /beta/loggedTime/{loggedTimeId}/tag | Get the tags for a loggedTime. [**updateLoggedTimeCustomFields**](LoggedTimeApi.md#updateLoggedTimeCustomFields) | **PUT** /beta/loggedTime/customFields | Update a loggedTime custom fields # **addLoggedTimeAudit** > addLoggedTimeAudit(loggedTimeId, loggedTimeAudit) Add new audit for a loggedTime Adds an audit to an existing loggedTime. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to add an audit to var loggedTimeAudit = "loggedTimeAudit_example"; // String | The audit to add var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.addLoggedTimeAudit(loggedTimeId, loggedTimeAudit, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to add an audit to | **loggedTimeAudit** | **String**| The audit to add | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **addLoggedTimeFile** > addLoggedTimeFile(loggedTimeId, fileName) Attach a file to a loggedTime Adds a file to an existing loggedTime. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to add a file to var fileName = "fileName_example"; // String | Name of file var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.addLoggedTimeFile(loggedTimeId, fileName, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to add a file to | **fileName** | **String**| Name of file | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **addLoggedTimeFileByURL** > addLoggedTimeFileByURL(body, loggedTimeId) Attach a file to a loggedTime by URL. Adds a file to an existing loggedTime by URL. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var body = new infoplus.RecordFile(); // RecordFile | The url and optionly fileName to be used. var loggedTimeId = 56; // Number | Id of the loggedTime to add an file to var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.addLoggedTimeFileByURL(body, loggedTimeId, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**RecordFile**](RecordFile.md)| The url and optionly fileName to be used. | **loggedTimeId** | **Number**| Id of the loggedTime to add an file to | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **addLoggedTimeTag** > addLoggedTimeTag(loggedTimeId, loggedTimeTag) Add new tags for a loggedTime. Adds a tag to an existing loggedTime. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to add a tag to var loggedTimeTag = "loggedTimeTag_example"; // String | The tag to add var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.addLoggedTimeTag(loggedTimeId, loggedTimeTag, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to add a tag to | **loggedTimeTag** | **String**| The tag to add | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json # **deleteLoggedTimeFile** > deleteLoggedTimeFile(loggedTimeId, fileId) Delete a file for a loggedTime. Deletes an existing loggedTime file using the specified data. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to remove file from var fileId = 56; // Number | Id of the file to delete var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.deleteLoggedTimeFile(loggedTimeId, fileId, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to remove file from | **fileId** | **Number**| Id of the file to delete | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **deleteLoggedTimeTag** > deleteLoggedTimeTag(loggedTimeId, loggedTimeTag) Delete a tag for a loggedTime. Deletes an existing loggedTime tag using the specified data. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to remove tag from var loggedTimeTag = "loggedTimeTag_example"; // String | The tag to delete var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.deleteLoggedTimeTag(loggedTimeId, loggedTimeTag, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to remove tag from | **loggedTimeTag** | **String**| The tag to delete | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getDuplicateLoggedTimeById** > LoggedTime getDuplicateLoggedTimeById(loggedTimeId) Get a duplicated a loggedTime by id Returns a duplicated loggedTime identified by the specified id. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to be duplicated. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getDuplicateLoggedTimeById(loggedTimeId, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to be duplicated. | ### Return type [**LoggedTime**](LoggedTime.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getLoggedTimeByFilter** > [LoggedTime] getLoggedTimeByFilter(opts) Search loggedTimes by filter Returns the list of loggedTimes that match the given filter. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var opts = { 'filter': "filter_example", // String | Query string, used to filter results. 'page': 56, // Number | Result page number. Defaults to 1. 'limit': 56, // Number | Maximum results per page. Defaults to 20. Max allowed value is 250. 'sort': "sort_example" // String | Sort results by specified field. }; var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getLoggedTimeByFilter(opts, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **String**| Query string, used to filter results. | [optional] **page** | **Number**| Result page number. Defaults to 1. | [optional] **limit** | **Number**| Maximum results per page. Defaults to 20. Max allowed value is 250. | [optional] **sort** | **String**| Sort results by specified field. | [optional] ### Return type [**[LoggedTime]**](LoggedTime.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getLoggedTimeById** > LoggedTime getLoggedTimeById(loggedTimeId) Get a loggedTime by id Returns the loggedTime identified by the specified id. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to be returned. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; apiInstance.getLoggedTimeById(loggedTimeId, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to be returned. | ### Return type [**LoggedTime**](LoggedTime.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getLoggedTimeFiles** > getLoggedTimeFiles(loggedTimeId) Get the files for a loggedTime. Get all existing loggedTime files. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to get files for var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.getLoggedTimeFiles(loggedTimeId, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to get files for | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **getLoggedTimeTags** > getLoggedTimeTags(loggedTimeId) Get the tags for a loggedTime. Get all existing loggedTime tags. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var loggedTimeId = 56; // Number | Id of the loggedTime to get tags for var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.getLoggedTimeTags(loggedTimeId, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loggedTimeId** | **Number**| Id of the loggedTime to get tags for | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json # **updateLoggedTimeCustomFields** > updateLoggedTimeCustomFields(body) Update a loggedTime custom fields Updates an existing loggedTime custom fields using the specified data. ### Example ```javascript var infoplus = require('infoplus-javascript-client'); var defaultClient = infoplus.ApiClient.instance; // Configure API key authorization: api_key var api_key = defaultClient.authentications['api_key']; api_key.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix = 'Token'; var apiInstance = new infoplus.LoggedTimeApi(); var body = new infoplus.LoggedTime(); // LoggedTime | LoggedTime to be updated. var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; apiInstance.updateLoggedTimeCustomFields(body, callback); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**LoggedTime**](LoggedTime.md)| LoggedTime to be updated. | ### Return type null (empty response body) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json