All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api
Method | HTTP request | Description |
---|---|---|
addJobTimeActivity | POST /beta/jobTimeActivity | Create a jobTimeActivity |
addJobTimeActivityAudit | PUT /beta/jobTimeActivity/{jobTimeActivityId}/audit/{jobTimeActivityAudit} | Add new audit for a jobTimeActivity |
addJobTimeActivityFile | POST /beta/jobTimeActivity/{jobTimeActivityId}/file/{fileName} | Attach a file to a jobTimeActivity |
addJobTimeActivityFileByURL | POST /beta/jobTimeActivity/{jobTimeActivityId}/file | Attach a file to a jobTimeActivity by URL. |
addJobTimeActivityTag | PUT /beta/jobTimeActivity/{jobTimeActivityId}/tag/{jobTimeActivityTag} | Add new tags for a jobTimeActivity. |
deleteJobTimeActivity | DELETE /beta/jobTimeActivity/{jobTimeActivityId} | Delete a jobTimeActivity |
deleteJobTimeActivityFile | DELETE /beta/jobTimeActivity/{jobTimeActivityId}/file/{fileId} | Delete a file for a jobTimeActivity. |
deleteJobTimeActivityTag | DELETE /beta/jobTimeActivity/{jobTimeActivityId}/tag/{jobTimeActivityTag} | Delete a tag for a jobTimeActivity. |
getDuplicateJobTimeActivityById | GET /beta/jobTimeActivity/duplicate/{jobTimeActivityId} | Get a duplicated a jobTimeActivity by id |
getJobTimeActivityByFilter | GET /beta/jobTimeActivity/search | Search jobTimeActivitys by filter |
getJobTimeActivityById | GET /beta/jobTimeActivity/{jobTimeActivityId} | Get a jobTimeActivity by id |
getJobTimeActivityFiles | GET /beta/jobTimeActivity/{jobTimeActivityId}/file | Get the files for a jobTimeActivity. |
getJobTimeActivityTags | GET /beta/jobTimeActivity/{jobTimeActivityId}/tag | Get the tags for a jobTimeActivity. |
updateJobTimeActivity | PUT /beta/jobTimeActivity | Update a jobTimeActivity |
\Infoplus\Infoplus\Model\JobTimeActivity addJobTimeActivity($body)
Create a jobTimeActivity
Inserts a new jobTimeActivity using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Infoplus\Infoplus\Model\JobTimeActivity(); // \Infoplus\Infoplus\Model\JobTimeActivity | JobTimeActivity to be inserted.
try {
$result = $apiInstance->addJobTimeActivity($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->addJobTimeActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\JobTimeActivity | JobTimeActivity to be inserted. |
\Infoplus\Infoplus\Model\JobTimeActivity
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addJobTimeActivityAudit($job_time_activity_id, $job_time_activity_audit)
Add new audit for a jobTimeActivity
Adds an audit to an existing jobTimeActivity.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to add an audit to
$job_time_activity_audit = "job_time_activity_audit_example"; // string | The audit to add
try {
$apiInstance->addJobTimeActivityAudit($job_time_activity_id, $job_time_activity_audit);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->addJobTimeActivityAudit: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to add an audit to | |
job_time_activity_audit | string | The audit to add |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addJobTimeActivityFile($job_time_activity_id, $file_name)
Attach a file to a jobTimeActivity
Adds a file to an existing jobTimeActivity.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to add a file to
$file_name = "file_name_example"; // string | Name of file
try {
$apiInstance->addJobTimeActivityFile($job_time_activity_id, $file_name);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->addJobTimeActivityFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to add a file to | |
file_name | string | Name of file |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addJobTimeActivityFileByURL($body, $job_time_activity_id)
Attach a file to a jobTimeActivity by URL.
Adds a file to an existing jobTimeActivity by URL.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Infoplus\Infoplus\Model\RecordFile(); // \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used.
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to add an file to
try {
$apiInstance->addJobTimeActivityFileByURL($body, $job_time_activity_id);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->addJobTimeActivityFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used. | |
job_time_activity_id | int | Id of the jobTimeActivity to add an file to |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addJobTimeActivityTag($job_time_activity_id, $job_time_activity_tag)
Add new tags for a jobTimeActivity.
Adds a tag to an existing jobTimeActivity.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to add a tag to
$job_time_activity_tag = "job_time_activity_tag_example"; // string | The tag to add
try {
$apiInstance->addJobTimeActivityTag($job_time_activity_id, $job_time_activity_tag);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->addJobTimeActivityTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to add a tag to | |
job_time_activity_tag | string | The tag to add |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteJobTimeActivity($job_time_activity_id)
Delete a jobTimeActivity
Deletes the jobTimeActivity identified by the specified id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to be deleted.
try {
$apiInstance->deleteJobTimeActivity($job_time_activity_id);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->deleteJobTimeActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to be deleted. |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteJobTimeActivityFile($job_time_activity_id, $file_id)
Delete a file for a jobTimeActivity.
Deletes an existing jobTimeActivity file using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to remove file from
$file_id = 56; // int | Id of the file to delete
try {
$apiInstance->deleteJobTimeActivityFile($job_time_activity_id, $file_id);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->deleteJobTimeActivityFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to remove file from | |
file_id | int | Id of the file to delete |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteJobTimeActivityTag($job_time_activity_id, $job_time_activity_tag)
Delete a tag for a jobTimeActivity.
Deletes an existing jobTimeActivity tag using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to remove tag from
$job_time_activity_tag = "job_time_activity_tag_example"; // string | The tag to delete
try {
$apiInstance->deleteJobTimeActivityTag($job_time_activity_id, $job_time_activity_tag);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->deleteJobTimeActivityTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to remove tag from | |
job_time_activity_tag | string | The tag to delete |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\JobTimeActivity getDuplicateJobTimeActivityById($job_time_activity_id)
Get a duplicated a jobTimeActivity by id
Returns a duplicated jobTimeActivity identified by the specified id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to be duplicated.
try {
$result = $apiInstance->getDuplicateJobTimeActivityById($job_time_activity_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->getDuplicateJobTimeActivityById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to be duplicated. |
\Infoplus\Infoplus\Model\JobTimeActivity
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\JobTimeActivity[] getJobTimeActivityByFilter($filter, $page, $limit, $sort)
Search jobTimeActivitys by filter
Returns the list of jobTimeActivitys that match the given filter.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$filter = "filter_example"; // string | Query string, used to filter results.
$page = 56; // int | Result page number. Defaults to 1.
$limit = 56; // int | Maximum results per page. Defaults to 20. Max allowed value is 250.
$sort = "sort_example"; // string | Sort results by specified field.
try {
$result = $apiInstance->getJobTimeActivityByFilter($filter, $page, $limit, $sort);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->getJobTimeActivityByFilter: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
filter | string | Query string, used to filter results. | [optional] |
page | int | Result page number. Defaults to 1. | [optional] |
limit | int | Maximum results per page. Defaults to 20. Max allowed value is 250. | [optional] |
sort | string | Sort results by specified field. | [optional] |
\Infoplus\Infoplus\Model\JobTimeActivity[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\JobTimeActivity getJobTimeActivityById($job_time_activity_id)
Get a jobTimeActivity by id
Returns the jobTimeActivity identified by the specified id.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to be returned.
try {
$result = $apiInstance->getJobTimeActivityById($job_time_activity_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->getJobTimeActivityById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to be returned. |
\Infoplus\Infoplus\Model\JobTimeActivity
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getJobTimeActivityFiles($job_time_activity_id)
Get the files for a jobTimeActivity.
Get all existing jobTimeActivity files.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to get files for
try {
$apiInstance->getJobTimeActivityFiles($job_time_activity_id);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->getJobTimeActivityFiles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to get files for |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getJobTimeActivityTags($job_time_activity_id)
Get the tags for a jobTimeActivity.
Get all existing jobTimeActivity tags.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$job_time_activity_id = 56; // int | Id of the jobTimeActivity to get tags for
try {
$apiInstance->getJobTimeActivityTags($job_time_activity_id);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->getJobTimeActivityTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
job_time_activity_id | int | Id of the jobTimeActivity to get tags for |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateJobTimeActivity($body)
Update a jobTimeActivity
Updates an existing jobTimeActivity using the specified data.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');
$apiInstance = new Infoplus\Api\JobTimeActivityApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \Infoplus\Infoplus\Model\JobTimeActivity(); // \Infoplus\Infoplus\Model\JobTimeActivity | JobTimeActivity to be updated.
try {
$apiInstance->updateJobTimeActivity($body);
} catch (Exception $e) {
echo 'Exception when calling JobTimeActivityApi->updateJobTimeActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\JobTimeActivity | JobTimeActivity to be updated. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]