Skip to content

Latest commit

 

History

History
855 lines (626 loc) · 24.8 KB

JobTimeApi.md

File metadata and controls

855 lines (626 loc) · 24.8 KB
Raw

JobTimeApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method HTTP request Description
addJobTime POST /beta/jobTime Create a jobTime
addJobTimeAudit PUT /beta/jobTime/{jobTimeId}/audit/{jobTimeAudit} Add new audit for a jobTime
addJobTimeFile POST /beta/jobTime/{jobTimeId}/file/{fileName} Attach a file to a jobTime
addJobTimeFileByURL POST /beta/jobTime/{jobTimeId}/file Attach a file to a jobTime by URL.
addJobTimeTag PUT /beta/jobTime/{jobTimeId}/tag/{jobTimeTag} Add new tags for a jobTime.
deleteJobTime DELETE /beta/jobTime/{jobTimeId} Delete a jobTime
deleteJobTimeFile DELETE /beta/jobTime/{jobTimeId}/file/{fileId} Delete a file for a jobTime.
deleteJobTimeTag DELETE /beta/jobTime/{jobTimeId}/tag/{jobTimeTag} Delete a tag for a jobTime.
getDuplicateJobTimeById GET /beta/jobTime/duplicate/{jobTimeId} Get a duplicated a jobTime by id
getJobTimeByFilter GET /beta/jobTime/search Search jobTimes by filter
getJobTimeById GET /beta/jobTime/{jobTimeId} Get a jobTime by id
getJobTimeFiles GET /beta/jobTime/{jobTimeId}/file Get the files for a jobTime.
getJobTimeTags GET /beta/jobTime/{jobTimeId}/tag Get the tags for a jobTime.
updateJobTime PUT /beta/jobTime Update a jobTime
updateJobTimeCustomFields PUT /beta/jobTime/customFields Update a jobTime custom fields

addJobTime

JobTime addJobTime(body)

Create a jobTime

Inserts a new jobTime using the specified data.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
JobTime body = new JobTime(); // JobTime | JobTime to be inserted.
try {
    JobTime result = apiInstance.addJobTime(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#addJobTime");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body JobTime JobTime to be inserted.

Return type

JobTime

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

addJobTimeAudit

addJobTimeAudit(jobTimeId, jobTimeAudit)

Add new audit for a jobTime

Adds an audit to an existing jobTime.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to add an audit to
String jobTimeAudit = "jobTimeAudit_example"; // String | The audit to add
try {
    apiInstance.addJobTimeAudit(jobTimeId, jobTimeAudit);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#addJobTimeAudit");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to add an audit to
jobTimeAudit String The audit to add

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

addJobTimeFile

addJobTimeFile(jobTimeId, fileName)

Attach a file to a jobTime

Adds a file to an existing jobTime.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to add a file to
String fileName = "fileName_example"; // String | Name of file
try {
    apiInstance.addJobTimeFile(jobTimeId, fileName);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#addJobTimeFile");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to add a file to
fileName String Name of file

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

addJobTimeFileByURL

addJobTimeFileByURL(body, jobTimeId)

Attach a file to a jobTime by URL.

Adds a file to an existing jobTime by URL.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
RecordFile body = new RecordFile(); // RecordFile | The url and optionly fileName to be used.
Integer jobTimeId = 56; // Integer | Id of the jobTime to add an file to
try {
    apiInstance.addJobTimeFileByURL(body, jobTimeId);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#addJobTimeFileByURL");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RecordFile The url and optionly fileName to be used.
jobTimeId Integer Id of the jobTime to add an file to

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

addJobTimeTag

addJobTimeTag(jobTimeId, jobTimeTag)

Add new tags for a jobTime.

Adds a tag to an existing jobTime.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to add a tag to
String jobTimeTag = "jobTimeTag_example"; // String | The tag to add
try {
    apiInstance.addJobTimeTag(jobTimeId, jobTimeTag);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#addJobTimeTag");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to add a tag to
jobTimeTag String The tag to add

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteJobTime

deleteJobTime(jobTimeId)

Delete a jobTime

Deletes the jobTime identified by the specified id.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to be deleted.
try {
    apiInstance.deleteJobTime(jobTimeId);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#deleteJobTime");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to be deleted.

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteJobTimeFile

deleteJobTimeFile(jobTimeId, fileId)

Delete a file for a jobTime.

Deletes an existing jobTime file using the specified data.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to remove file from
Integer fileId = 56; // Integer | Id of the file to delete
try {
    apiInstance.deleteJobTimeFile(jobTimeId, fileId);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#deleteJobTimeFile");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to remove file from
fileId Integer Id of the file to delete

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

deleteJobTimeTag

deleteJobTimeTag(jobTimeId, jobTimeTag)

Delete a tag for a jobTime.

Deletes an existing jobTime tag using the specified data.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to remove tag from
String jobTimeTag = "jobTimeTag_example"; // String | The tag to delete
try {
    apiInstance.deleteJobTimeTag(jobTimeId, jobTimeTag);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#deleteJobTimeTag");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to remove tag from
jobTimeTag String The tag to delete

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getDuplicateJobTimeById

JobTime getDuplicateJobTimeById(jobTimeId)

Get a duplicated a jobTime by id

Returns a duplicated jobTime identified by the specified id.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to be duplicated.
try {
    JobTime result = apiInstance.getDuplicateJobTimeById(jobTimeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#getDuplicateJobTimeById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to be duplicated.

Return type

JobTime

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getJobTimeByFilter

List<JobTime> getJobTimeByFilter(filter, page, limit, sort)

Search jobTimes by filter

Returns the list of jobTimes that match the given filter.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
String filter = "filter_example"; // String | Query string, used to filter results.
Integer page = 56; // Integer | Result page number.  Defaults to 1.
Integer limit = 56; // Integer | Maximum results per page.  Defaults to 20.  Max allowed value is 250.
String sort = "sort_example"; // String | Sort results by specified field.
try {
    List<JobTime> result = apiInstance.getJobTimeByFilter(filter, page, limit, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#getJobTimeByFilter");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter String Query string, used to filter results. [optional]
page Integer Result page number. Defaults to 1. [optional]
limit Integer Maximum results per page. Defaults to 20. Max allowed value is 250. [optional]
sort String Sort results by specified field. [optional]

Return type

List<JobTime>

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getJobTimeById

JobTime getJobTimeById(jobTimeId)

Get a jobTime by id

Returns the jobTime identified by the specified id.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to be returned.
try {
    JobTime result = apiInstance.getJobTimeById(jobTimeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#getJobTimeById");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to be returned.

Return type

JobTime

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getJobTimeFiles

getJobTimeFiles(jobTimeId)

Get the files for a jobTime.

Get all existing jobTime files.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to get files for
try {
    apiInstance.getJobTimeFiles(jobTimeId);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#getJobTimeFiles");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to get files for

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getJobTimeTags

getJobTimeTags(jobTimeId)

Get the tags for a jobTime.

Get all existing jobTime tags.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
Integer jobTimeId = 56; // Integer | Id of the jobTime to get tags for
try {
    apiInstance.getJobTimeTags(jobTimeId);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#getJobTimeTags");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobTimeId Integer Id of the jobTime to get tags for

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateJobTime

updateJobTime(body)

Update a jobTime

Updates an existing jobTime using the specified data.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
JobTime body = new JobTime(); // JobTime | JobTime to be updated.
try {
    apiInstance.updateJobTime(body);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#updateJobTime");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body JobTime JobTime to be updated.

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateJobTimeCustomFields

updateJobTimeCustomFields(body)

Update a jobTime custom fields

Updates an existing jobTime custom fields using the specified data.

Example

// Import classes:
//import com.infopluscommerce.ApiClient;
//import com.infopluscommerce.ApiException;
//import com.infopluscommerce.Configuration;
//import com.infopluscommerce.auth.*;
//import com.infopluscommerce.api.JobTimeApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: api_key
ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
api_key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.setApiKeyPrefix("Token");

JobTimeApi apiInstance = new JobTimeApi();
JobTime body = new JobTime(); // JobTime | JobTime to be updated.
try {
    apiInstance.updateJobTimeCustomFields(body);
} catch (ApiException e) {
    System.err.println("Exception when calling JobTimeApi#updateJobTimeCustomFields");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body JobTime JobTime to be updated.

Return type

null (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json