Infoplus\WorkApi

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

Method	HTTP request	Description
addWorkAudit	PUT /beta/work/{workId}/audit/{workAudit}	Add new audit for a work
addWorkFile	POST /beta/work/{workId}/file/{fileName}	Attach a file to a work
addWorkFileByURL	POST /beta/work/{workId}/file	Attach a file to a work by URL.
addWorkTag	PUT /beta/work/{workId}/tag/{workTag}	Add new tags for a work.
deleteWorkFile	DELETE /beta/work/{workId}/file/{fileId}	Delete a file for a work.
deleteWorkTag	DELETE /beta/work/{workId}/tag/{workTag}	Delete a tag for a work.
getDuplicateWorkById	GET /beta/work/duplicate/{workId}	Get a duplicated a work by id
getWorkByFilter	GET /beta/work/search	Search works by filter
getWorkById	GET /beta/work/{workId}	Get a work by id
getWorkFiles	GET /beta/work/{workId}/file	Get the files for a work.
getWorkTags	GET /beta/work/{workId}/tag	Get the tags for a work.
updateWork	PUT /beta/work	Update a work
updateWorkCustomFields	PUT /beta/work/customFields	Update a work custom fields

addWorkAudit

addWorkAudit($work_id, $work_audit)

Add new audit for a work

Adds an audit to an existing work.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to add an audit to
$work_audit = "work_audit_example"; // string | The audit to add

try {
    $apiInstance->addWorkAudit($work_id, $work_audit);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->addWorkAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to add an audit to
work_audit	string	The audit to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addWorkFile

addWorkFile($work_id, $file_name)

Attach a file to a work

Adds a file to an existing work.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to add a file to
$file_name = "file_name_example"; // string | Name of file

try {
    $apiInstance->addWorkFile($work_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->addWorkFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to add a file to
file_name	string	Name of file

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addWorkFileByURL

addWorkFileByURL($body, $work_id)

Attach a file to a work by URL.

Adds a file to an existing work by URL.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to add an file to

try {
    $apiInstance->addWorkFileByURL($body, $work_id);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->addWorkFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\RecordFile	The url and optionly fileName to be used.
work_id	int	Id of the work to add an file to

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addWorkTag

addWorkTag($work_id, $work_tag)

Add new tags for a work.

Adds a tag to an existing work.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to add a tag to
$work_tag = "work_tag_example"; // string | The tag to add

try {
    $apiInstance->addWorkTag($work_id, $work_tag);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->addWorkTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to add a tag to
work_tag	string	The tag to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteWorkFile

deleteWorkFile($work_id, $file_id)

Delete a file for a work.

Deletes an existing work file using the specified data.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to remove file from
$file_id = 56; // int | Id of the file to delete

try {
    $apiInstance->deleteWorkFile($work_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->deleteWorkFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to remove file from
file_id	int	Id of the file to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteWorkTag

deleteWorkTag($work_id, $work_tag)

Delete a tag for a work.

Deletes an existing work tag using the specified data.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to remove tag from
$work_tag = "work_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteWorkTag($work_id, $work_tag);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->deleteWorkTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to remove tag from
work_tag	string	The tag to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDuplicateWorkById

\Infoplus\Infoplus\Model\Work getDuplicateWorkById($work_id)

Get a duplicated a work by id

Returns a duplicated work identified by the specified id.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to be duplicated.

try {
    $result = $apiInstance->getDuplicateWorkById($work_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->getDuplicateWorkById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to be duplicated.

Return type

\Infoplus\Infoplus\Model\Work

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWorkByFilter

\Infoplus\Infoplus\Model\Work[] getWorkByFilter($filter, $page, $limit, $sort)

Search works by filter

Returns the list of works that match the given filter.

Example

<?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\WorkApi(
    // 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->getWorkByFilter($filter, $page, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->getWorkByFilter: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

\Infoplus\Infoplus\Model\Work[]

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWorkById

\Infoplus\Infoplus\Model\Work getWorkById($work_id)

Get a work by id

Returns the work identified by the specified id.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to be returned.

try {
    $result = $apiInstance->getWorkById($work_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->getWorkById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to be returned.

Return type

\Infoplus\Infoplus\Model\Work

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWorkFiles

getWorkFiles($work_id)

Get the files for a work.

Get all existing work files.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to get files for

try {
    $apiInstance->getWorkFiles($work_id);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->getWorkFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to get files for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getWorkTags

getWorkTags($work_id)

Get the tags for a work.

Get all existing work tags.

Example

<?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\WorkApi(
    // 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_id = 56; // int | Id of the work to get tags for

try {
    $apiInstance->getWorkTags($work_id);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->getWorkTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
work_id	int	Id of the work to get tags for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateWork

updateWork($body)

Update a work

Updates an existing work using the specified data.

Example

<?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\WorkApi(
    // 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\Work(); // \Infoplus\Infoplus\Model\Work | Work to be updated.

try {
    $apiInstance->updateWork($body);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->updateWork: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\Work	Work to be updated.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateWorkCustomFields

updateWorkCustomFields($body)

Update a work custom fields

Updates an existing work custom fields using the specified data.

Example

<?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\WorkApi(
    // 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\Work(); // \Infoplus\Infoplus\Model\Work | Work to be updated.

try {
    $apiInstance->updateWorkCustomFields($body);
} catch (Exception $e) {
    echo 'Exception when calling WorkApi->updateWorkCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\Work	Work to be updated.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

WorkApi.md

Latest commit

History

WorkApi.md

File metadata and controls

Infoplus\WorkApi

addWorkAudit

Example

Parameters

Return type

Authorization

HTTP request headers

addWorkFile

Example

Parameters

Return type

Authorization

HTTP request headers

addWorkFileByURL

Example

Parameters

Return type

Authorization

HTTP request headers

addWorkTag

Example

Parameters

Return type

Authorization

HTTP request headers

deleteWorkFile

Example

Parameters

Return type

Authorization

HTTP request headers

deleteWorkTag

Example

Parameters

Return type

Authorization

HTTP request headers

getDuplicateWorkById

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkByFilter

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkById

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkFiles

Example

Parameters

Return type

Authorization

HTTP request headers

getWorkTags

Example

Parameters

Return type

Authorization

HTTP request headers

updateWork

Example

Parameters

Return type

Authorization

HTTP request headers

updateWorkCustomFields