Infoplus\CustomFieldApi

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

Method	HTTP request	Description
addCustomField	POST /beta/customField	Create a customField
addCustomFieldAudit	PUT /beta/customField/{customFieldId}/audit/{customFieldAudit}	Add new audit for a customField
addCustomFieldFile	POST /beta/customField/{customFieldId}/file/{fileName}	Attach a file to a customField
addCustomFieldFileByURL	POST /beta/customField/{customFieldId}/file	Attach a file to a customField by URL.
addCustomFieldTag	PUT /beta/customField/{customFieldId}/tag/{customFieldTag}	Add new tags for a customField.
deleteCustomFieldFile	DELETE /beta/customField/{customFieldId}/file/{fileId}	Delete a file for a customField.
deleteCustomFieldTag	DELETE /beta/customField/{customFieldId}/tag/{customFieldTag}	Delete a tag for a customField.
getCustomFieldByFilter	GET /beta/customField/search	Search customFields by filter
getCustomFieldById	GET /beta/customField/{customFieldId}	Get a customField by id
getCustomFieldFiles	GET /beta/customField/{customFieldId}/file	Get the files for a customField.
getCustomFieldTags	GET /beta/customField/{customFieldId}/tag	Get the tags for a customField.
getDuplicateCustomFieldById	GET /beta/customField/duplicate/{customFieldId}	Get a duplicated a customField by id
updateCustomField	PUT /beta/customField	Update a customField

addCustomField

\Infoplus\Infoplus\Model\CustomField addCustomField($body)

Create a customField

Inserts a new customField 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\CustomFieldApi(
    // 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\CustomField(); // \Infoplus\Infoplus\Model\CustomField | CustomField to be inserted.

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

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\CustomField	CustomField to be inserted.

Return type

\Infoplus\Infoplus\Model\CustomField

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]

addCustomFieldAudit

addCustomFieldAudit($custom_field_id, $custom_field_audit)

Add new audit for a customField

Adds an audit to an existing customField.

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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to add an audit to
$custom_field_audit = "custom_field_audit_example"; // string | The audit to add

try {
    $apiInstance->addCustomFieldAudit($custom_field_id, $custom_field_audit);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->addCustomFieldAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField to add an audit to
custom_field_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]

addCustomFieldFile

addCustomFieldFile($custom_field_id, $file_name)

Attach a file to a customField

Adds a file to an existing customField.

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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to add a file to
$file_name = "file_name_example"; // string | Name of file

try {
    $apiInstance->addCustomFieldFile($custom_field_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->addCustomFieldFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField 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]

addCustomFieldFileByURL

addCustomFieldFileByURL($body, $custom_field_id)

Attach a file to a customField by URL.

Adds a file to an existing customField 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\CustomFieldApi(
    // 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.
$custom_field_id = 56; // int | Id of the customField to add an file to

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

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\RecordFile	The url and optionly fileName to be used.
custom_field_id	int	Id of the customField 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]

addCustomFieldTag

addCustomFieldTag($custom_field_id, $custom_field_tag)

Add new tags for a customField.

Adds a tag to an existing customField.

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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to add a tag to
$custom_field_tag = "custom_field_tag_example"; // string | The tag to add

try {
    $apiInstance->addCustomFieldTag($custom_field_id, $custom_field_tag);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->addCustomFieldTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField to add a tag to
custom_field_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]

deleteCustomFieldFile

deleteCustomFieldFile($custom_field_id, $file_id)

Delete a file for a customField.

Deletes an existing customField 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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to remove file from
$file_id = 56; // int | Id of the file to delete

try {
    $apiInstance->deleteCustomFieldFile($custom_field_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->deleteCustomFieldFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField 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]

deleteCustomFieldTag

deleteCustomFieldTag($custom_field_id, $custom_field_tag)

Delete a tag for a customField.

Deletes an existing customField 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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to remove tag from
$custom_field_tag = "custom_field_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteCustomFieldTag($custom_field_id, $custom_field_tag);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->deleteCustomFieldTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField to remove tag from
custom_field_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]

getCustomFieldByFilter

\Infoplus\Infoplus\Model\CustomField[] getCustomFieldByFilter($filter, $page, $limit, $sort)

Search customFields by filter

Returns the list of customFields 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\CustomFieldApi(
    // 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->getCustomFieldByFilter($filter, $page, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->getCustomFieldByFilter: ', $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\CustomField[]

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]

getCustomFieldById

\Infoplus\Infoplus\Model\CustomField getCustomFieldById($custom_field_id)

Get a customField by id

Returns the customField 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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to be returned.

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

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField to be returned.

Return type

\Infoplus\Infoplus\Model\CustomField

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]

getCustomFieldFiles

getCustomFieldFiles($custom_field_id)

Get the files for a customField.

Get all existing customField 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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to get files for

try {
    $apiInstance->getCustomFieldFiles($custom_field_id);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->getCustomFieldFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField 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]

getCustomFieldTags

getCustomFieldTags($custom_field_id)

Get the tags for a customField.

Get all existing customField 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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to get tags for

try {
    $apiInstance->getCustomFieldTags($custom_field_id);
} catch (Exception $e) {
    echo 'Exception when calling CustomFieldApi->getCustomFieldTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField 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]

getDuplicateCustomFieldById

\Infoplus\Infoplus\Model\CustomField getDuplicateCustomFieldById($custom_field_id)

Get a duplicated a customField by id

Returns a duplicated customField 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\CustomFieldApi(
    // 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
);
$custom_field_id = 56; // int | Id of the customField to be duplicated.

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

Parameters

Name	Type	Description	Notes
custom_field_id	int	Id of the customField to be duplicated.

Return type

\Infoplus\Infoplus\Model\CustomField

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]

updateCustomField

updateCustomField($body)

Update a customField

Updates an existing customField 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\CustomFieldApi(
    // 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\CustomField(); // \Infoplus\Infoplus\Model\CustomField | CustomField to be updated.

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

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\CustomField	CustomField 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

CustomFieldApi.md

Latest commit

History

CustomFieldApi.md

File metadata and controls

Infoplus\CustomFieldApi

addCustomField

Example

Parameters

Return type

Authorization

HTTP request headers

addCustomFieldAudit

Example

Parameters

Return type

Authorization

HTTP request headers

addCustomFieldFile

Example

Parameters

Return type

Authorization

HTTP request headers

addCustomFieldFileByURL

Example

Parameters

Return type

Authorization

HTTP request headers

addCustomFieldTag

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCustomFieldFile

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCustomFieldTag

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomFieldByFilter

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomFieldById

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomFieldFiles

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomFieldTags

Example

Parameters

Return type

Authorization

HTTP request headers

getDuplicateCustomFieldById

Example

Parameters

Return type

Authorization

HTTP request headers

updateCustomField