All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api
Method | HTTP request | Description |
---|---|---|
addWorkActivity | POST /beta/workActivity | Create a workActivity |
addWorkActivityAudit | PUT /beta/workActivity/{workActivityId}/audit/{workActivityAudit} | Add new audit for a workActivity |
addWorkActivityFile | POST /beta/workActivity/{workActivityId}/file/{fileName} | Attach a file to a workActivity |
addWorkActivityFileByURL | POST /beta/workActivity/{workActivityId}/file | Attach a file to a workActivity by URL. |
addWorkActivityTag | PUT /beta/workActivity/{workActivityId}/tag/{workActivityTag} | Add new tags for a workActivity. |
deleteWorkActivity | DELETE /beta/workActivity/{workActivityId} | Delete a workActivity |
deleteWorkActivityFile | DELETE /beta/workActivity/{workActivityId}/file/{fileId} | Delete a file for a workActivity. |
deleteWorkActivityTag | DELETE /beta/workActivity/{workActivityId}/tag/{workActivityTag} | Delete a tag for a workActivity. |
getDuplicateWorkActivityById | GET /beta/workActivity/duplicate/{workActivityId} | Get a duplicated a workActivity by id |
getWorkActivityByFilter | GET /beta/workActivity/search | Search workActivitys by filter |
getWorkActivityById | GET /beta/workActivity/{workActivityId} | Get a workActivity by id |
getWorkActivityFiles | GET /beta/workActivity/{workActivityId}/file | Get the files for a workActivity. |
getWorkActivityTags | GET /beta/workActivity/{workActivityId}/tag | Get the tags for a workActivity. |
updateWorkActivity | PUT /beta/workActivity | Update a workActivity |
\Infoplus\Infoplus\Model\WorkActivity addWorkActivity($body)
Create a workActivity
Inserts a new workActivity 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\WorkActivityApi(
// 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\WorkActivity(); // \Infoplus\Infoplus\Model\WorkActivity | WorkActivity to be inserted.
try {
$result = $apiInstance->addWorkActivity($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->addWorkActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\WorkActivity | WorkActivity to be inserted. |
\Infoplus\Infoplus\Model\WorkActivity
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addWorkActivityAudit($work_activity_id, $work_activity_audit)
Add new audit for a workActivity
Adds an audit to an existing workActivity.
<?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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to add an audit to
$work_activity_audit = "work_activity_audit_example"; // string | The audit to add
try {
$apiInstance->addWorkActivityAudit($work_activity_id, $work_activity_audit);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->addWorkActivityAudit: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity to add an audit to | |
work_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]
addWorkActivityFile($work_activity_id, $file_name)
Attach a file to a workActivity
Adds a file to an existing workActivity.
<?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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to add a file to
$file_name = "file_name_example"; // string | Name of file
try {
$apiInstance->addWorkActivityFile($work_activity_id, $file_name);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->addWorkActivityFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity 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]
addWorkActivityFileByURL($body, $work_activity_id)
Attach a file to a workActivity by URL.
Adds a file to an existing workActivity 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\WorkActivityApi(
// 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.
$work_activity_id = 56; // int | Id of the workActivity to add an file to
try {
$apiInstance->addWorkActivityFileByURL($body, $work_activity_id);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->addWorkActivityFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used. | |
work_activity_id | int | Id of the workActivity 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]
addWorkActivityTag($work_activity_id, $work_activity_tag)
Add new tags for a workActivity.
Adds a tag to an existing workActivity.
<?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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to add a tag to
$work_activity_tag = "work_activity_tag_example"; // string | The tag to add
try {
$apiInstance->addWorkActivityTag($work_activity_id, $work_activity_tag);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->addWorkActivityTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity to add a tag to | |
work_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]
deleteWorkActivity($work_activity_id)
Delete a workActivity
Deletes the workActivity 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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to be deleted.
try {
$apiInstance->deleteWorkActivity($work_activity_id);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->deleteWorkActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity 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]
deleteWorkActivityFile($work_activity_id, $file_id)
Delete a file for a workActivity.
Deletes an existing workActivity 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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to remove file from
$file_id = 56; // int | Id of the file to delete
try {
$apiInstance->deleteWorkActivityFile($work_activity_id, $file_id);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->deleteWorkActivityFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity 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]
deleteWorkActivityTag($work_activity_id, $work_activity_tag)
Delete a tag for a workActivity.
Deletes an existing workActivity 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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to remove tag from
$work_activity_tag = "work_activity_tag_example"; // string | The tag to delete
try {
$apiInstance->deleteWorkActivityTag($work_activity_id, $work_activity_tag);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->deleteWorkActivityTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity to remove tag from | |
work_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\WorkActivity getDuplicateWorkActivityById($work_activity_id)
Get a duplicated a workActivity by id
Returns a duplicated workActivity 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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to be duplicated.
try {
$result = $apiInstance->getDuplicateWorkActivityById($work_activity_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->getDuplicateWorkActivityById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity to be duplicated. |
\Infoplus\Infoplus\Model\WorkActivity
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\WorkActivity[] getWorkActivityByFilter($filter, $page, $limit, $sort)
Search workActivitys by filter
Returns the list of workActivitys 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\WorkActivityApi(
// 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->getWorkActivityByFilter($filter, $page, $limit, $sort);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->getWorkActivityByFilter: ', $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\WorkActivity[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\WorkActivity getWorkActivityById($work_activity_id)
Get a workActivity by id
Returns the workActivity 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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to be returned.
try {
$result = $apiInstance->getWorkActivityById($work_activity_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->getWorkActivityById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity to be returned. |
\Infoplus\Infoplus\Model\WorkActivity
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getWorkActivityFiles($work_activity_id)
Get the files for a workActivity.
Get all existing workActivity 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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to get files for
try {
$apiInstance->getWorkActivityFiles($work_activity_id);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->getWorkActivityFiles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity 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]
getWorkActivityTags($work_activity_id)
Get the tags for a workActivity.
Get all existing workActivity 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\WorkActivityApi(
// 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
);
$work_activity_id = 56; // int | Id of the workActivity to get tags for
try {
$apiInstance->getWorkActivityTags($work_activity_id);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->getWorkActivityTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
work_activity_id | int | Id of the workActivity 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]
updateWorkActivity($body)
Update a workActivity
Updates an existing workActivity 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\WorkActivityApi(
// 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\WorkActivity(); // \Infoplus\Infoplus\Model\WorkActivity | WorkActivity to be updated.
try {
$apiInstance->updateWorkActivity($body);
} catch (Exception $e) {
echo 'Exception when calling WorkActivityApi->updateWorkActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\WorkActivity | WorkActivity 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]