Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 4.66 KB

README.md

File metadata and controls

66 lines (44 loc) · 4.66 KB
Raw

ConnectorResources

(connector->connectorResources)

Overview

Available Operations

  • get - Get Connector Resource

get

Get Connector Resource

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity($security)->build();



$response = $sdk->connector->connectorResources->get(
    id: '<id>',
    resourceId: '<id>',
    appId: 'dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX',
    unifiedApi: Components\UnifiedApiId::Crm

);

if ($response->getConnectorResourceResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description Example
id string ✔️ ID of the record you are acting upon.
resourceId string ✔️ ID of the resource you are acting upon.
appId ?string ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
unifiedApi ?Components\UnifiedApiId ➖ Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs crm

Response

?Operations\ConnectorConnectorResourcesOneResponse

Errors

Error Type Status Code Content Type
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\APIException 4XX, 5XX */*