CheckerApi.md

OpenAPI\Client\CheckerApi

All URIs are relative to https://api.bimdata.io.

Method	HTTP request	Description
createChecker()	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker	Create a checker to a model
createCheckerResult()	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result	Create a CheckerResult
createCheckplan()	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan	Create a Checkplan
createRule()	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule	Create a Rule
createRuleComponent()	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent	Create a RuleComponent
createRuleset()	POST /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset	Create a Ruleset
deleteChecker()	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}	Delete a checker of a model
deleteCheckerResult()	DELETE /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}	Delete a CheckerResult
deleteCheckplan()	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}	Delete a Checkplan
deleteRule()	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}	Delete a Rule
deleteRuleComponent()	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}	Delete a RuleComponent
deleteRuleset()	DELETE /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}	Delete a Ruleset
fullUpdateChecker()	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}	Update all fields of a checker of a model
fullUpdateCheckerResult()	PUT /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}	Update all fields of a CheckerResult
fullUpdateCheckplan()	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}	Update all fields of a Checkplan
fullUpdateRule()	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}	Update all fields of a Rule
fullUpdateRuleComponent()	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}	Update all fields of a RuleComponent
fullUpdateRuleset()	PUT /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}	Update all fields of a Ruleset
getChecker()	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}	Retrieve a checker of a model
getCheckerResult()	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}	Retrieve one CheckerResult
getCheckerResults()	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result	Retrieve all CheckerResults
getCheckers()	GET /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker	Retrieve all checkers of a model
getCheckplan()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}	Retrieve one Checkplan
getCheckplans()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan	Retrieve all Checkplans
getRule()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}	Retrieve one Rule
getRuleComponent()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}	Retrieve one RuleComponent
getRuleComponents()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent	Retrieve all RuleComponents
getRules()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule	Retrieve all Rules
getRuleset()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}	Retrieve one Ruleset
getRulesets()	GET /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset	Retrieve all Rulesets
launchNewCheck()	POST /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}/launch-check	Launch a new check on the model
updateChecker()	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{id}	Update some fields of a checker of a model
updateCheckerResult()	PATCH /cloud/{cloud_pk}/project/{project_pk}/ifc/{ifc_pk}/checker/{checker_pk}/result/{id}	Update some fields of a CheckerResult
updateCheckplan()	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{id}	Update some fields of a Checkplan
updateRule()	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{id}	Update some fields of a Rule
updateRuleComponent()	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{ruleset_pk}/rule/{rule_pk}/rulecomponent/{id}	Update some fields of a RuleComponent
updateRuleset()	PATCH /cloud/{cloud_pk}/project/{project_pk}/checkplan/{check_plan_pk}/ruleset/{id}	Update some fields of a Ruleset

createChecker()

createChecker($cloud_pk, $ifc_pk, $project_pk, $data): \OpenAPI\Client\Model\IfcChecker

Create a checker to a model

A checker is a link between a checkplan and a model. A checker can launch a check multiple time and store all the results Required scopes: check:write, ifc:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\IfcChecker(); // \OpenAPI\Client\Model\IfcChecker

try {
    $result = $apiInstance->createChecker($cloud_pk, $ifc_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->createChecker: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
ifc_pk	string
project_pk	string
data	\OpenAPI\Client\Model\IfcChecker

Return type

\OpenAPI\Client\Model\IfcChecker

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

createCheckerResult()

createCheckerResult($checker_pk, $cloud_pk, $ifc_pk, $project_pk, $data): \OpenAPI\Client\Model\CheckerResult

Create a CheckerResult

TCreate a CheckerResult Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$checker_pk = 'checker_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\CheckerResult(); // \OpenAPI\Client\Model\CheckerResult

try {
    $result = $apiInstance->createCheckerResult($checker_pk, $cloud_pk, $ifc_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->createCheckerResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
checker_pk	string
cloud_pk	string
ifc_pk	string
project_pk	string
data	\OpenAPI\Client\Model\CheckerResult

Return type

\OpenAPI\Client\Model\CheckerResult

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

createCheckplan()

createCheckplan($cloud_pk, $project_pk, $data): \OpenAPI\Client\Model\CheckPlan

Create a Checkplan

TCreate a Checkplan Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\CheckPlan(); // \OpenAPI\Client\Model\CheckPlan

try {
    $result = $apiInstance->createCheckplan($cloud_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->createCheckplan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
project_pk	string
data	\OpenAPI\Client\Model\CheckPlan

Return type

\OpenAPI\Client\Model\CheckPlan

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

createRule()

createRule($check_plan_pk, $cloud_pk, $project_pk, $ruleset_pk, $data): \OpenAPI\Client\Model\Rule

Create a Rule

TCreate a Rule Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string
$data = new \OpenAPI\Client\Model\Rule(); // \OpenAPI\Client\Model\Rule

try {
    $result = $apiInstance->createRule($check_plan_pk, $cloud_pk, $project_pk, $ruleset_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->createRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
project_pk	string
ruleset_pk	string
data	\OpenAPI\Client\Model\Rule

Return type

\OpenAPI\Client\Model\Rule

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

createRuleComponent()

createRuleComponent($check_plan_pk, $cloud_pk, $project_pk, $rule_pk, $ruleset_pk, $data): \OpenAPI\Client\Model\RuleComponent

Create a RuleComponent

TCreate a RuleComponent Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$rule_pk = 'rule_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string
$data = new \OpenAPI\Client\Model\RuleComponent(); // \OpenAPI\Client\Model\RuleComponent

try {
    $result = $apiInstance->createRuleComponent($check_plan_pk, $cloud_pk, $project_pk, $rule_pk, $ruleset_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->createRuleComponent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
project_pk	string
rule_pk	string
ruleset_pk	string
data	\OpenAPI\Client\Model\RuleComponent

Return type

\OpenAPI\Client\Model\RuleComponent

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

createRuleset()

createRuleset($check_plan_pk, $cloud_pk, $project_pk, $data): \OpenAPI\Client\Model\Ruleset

Create a Ruleset

TCreate a Ruleset Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\Ruleset(); // \OpenAPI\Client\Model\Ruleset

try {
    $result = $apiInstance->createRuleset($check_plan_pk, $cloud_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->createRuleset: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
project_pk	string
data	\OpenAPI\Client\Model\Ruleset

Return type

\OpenAPI\Client\Model\Ruleset

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

deleteChecker()

deleteChecker($cloud_pk, $id, $ifc_pk, $project_pk)

Delete a checker of a model

A checker is a link between a checkplan and a model. A checker can launch a check multiple time and store all the results Required scopes: check:write, ifc:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ifc checker.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $apiInstance->deleteChecker($cloud_pk, $id, $ifc_pk, $project_pk);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->deleteChecker: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this ifc checker.
ifc_pk	string
project_pk	string

Return type

void (empty response body)

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteCheckerResult()

deleteCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk)

Delete a CheckerResult

Delete a CheckerResult Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$checker_pk = 'checker_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this checker result.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $apiInstance->deleteCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->deleteCheckerResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
checker_pk	string
cloud_pk	string
id	int	A unique integer value identifying this checker result.
ifc_pk	string
project_pk	string

Return type

void (empty response body)

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteCheckplan()

deleteCheckplan($cloud_pk, $id, $project_pk)

Delete a Checkplan

Delete a Checkplan Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this check plan.
$project_pk = 'project_pk_example'; // string

try {
    $apiInstance->deleteCheckplan($cloud_pk, $id, $project_pk);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->deleteCheckplan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this check plan.
project_pk	string

Return type

void (empty response body)

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteRule()

deleteRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk)

Delete a Rule

Delete a Rule Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule.
$project_pk = 'project_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string

try {
    $apiInstance->deleteRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->deleteRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule.
project_pk	string
ruleset_pk	string

Return type

void (empty response body)

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteRuleComponent()

deleteRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk)

Delete a RuleComponent

Delete a RuleComponent Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule component.
$project_pk = 'project_pk_example'; // string
$rule_pk = 'rule_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string

try {
    $apiInstance->deleteRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->deleteRuleComponent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule component.
project_pk	string
rule_pk	string
ruleset_pk	string

Return type

void (empty response body)

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

deleteRuleset()

deleteRuleset($check_plan_pk, $cloud_pk, $id, $project_pk)

Delete a Ruleset

Delete a Ruleset Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ruleset.
$project_pk = 'project_pk_example'; // string

try {
    $apiInstance->deleteRuleset($check_plan_pk, $cloud_pk, $id, $project_pk);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->deleteRuleset: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this ruleset.
project_pk	string

Return type

void (empty response body)

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

fullUpdateChecker()

fullUpdateChecker($cloud_pk, $id, $ifc_pk, $project_pk, $data): \OpenAPI\Client\Model\IfcChecker

Update all fields of a checker of a model

A checker is a link between a checkplan and a model. A checker can launch a check multiple time and store all the results Required scopes: check:write, ifc:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ifc checker.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\IfcChecker(); // \OpenAPI\Client\Model\IfcChecker

try {
    $result = $apiInstance->fullUpdateChecker($cloud_pk, $id, $ifc_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->fullUpdateChecker: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this ifc checker.
ifc_pk	string
project_pk	string
data	\OpenAPI\Client\Model\IfcChecker

Return type

\OpenAPI\Client\Model\IfcChecker

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

fullUpdateCheckerResult()

fullUpdateCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk, $data): \OpenAPI\Client\Model\CheckerResult

Update all fields of a CheckerResult

Update all fields of a CheckerResult Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$checker_pk = 'checker_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this checker result.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\CheckerResult(); // \OpenAPI\Client\Model\CheckerResult

try {
    $result = $apiInstance->fullUpdateCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->fullUpdateCheckerResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
checker_pk	string
cloud_pk	string
id	int	A unique integer value identifying this checker result.
ifc_pk	string
project_pk	string
data	\OpenAPI\Client\Model\CheckerResult

Return type

\OpenAPI\Client\Model\CheckerResult

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

fullUpdateCheckplan()

fullUpdateCheckplan($cloud_pk, $id, $project_pk, $data): \OpenAPI\Client\Model\CheckPlan

Update all fields of a Checkplan

Update all fields of a Checkplan Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this check plan.
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\CheckPlan(); // \OpenAPI\Client\Model\CheckPlan

try {
    $result = $apiInstance->fullUpdateCheckplan($cloud_pk, $id, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->fullUpdateCheckplan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this check plan.
project_pk	string
data	\OpenAPI\Client\Model\CheckPlan

Return type

\OpenAPI\Client\Model\CheckPlan

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

fullUpdateRule()

fullUpdateRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk, $data): \OpenAPI\Client\Model\Rule

Update all fields of a Rule

Update all fields of a Rule Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule.
$project_pk = 'project_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string
$data = new \OpenAPI\Client\Model\Rule(); // \OpenAPI\Client\Model\Rule

try {
    $result = $apiInstance->fullUpdateRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->fullUpdateRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule.
project_pk	string
ruleset_pk	string
data	\OpenAPI\Client\Model\Rule

Return type

\OpenAPI\Client\Model\Rule

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

fullUpdateRuleComponent()

fullUpdateRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk, $data): \OpenAPI\Client\Model\RuleComponent

Update all fields of a RuleComponent

Update all fields of a RuleComponent Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule component.
$project_pk = 'project_pk_example'; // string
$rule_pk = 'rule_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string
$data = new \OpenAPI\Client\Model\RuleComponent(); // \OpenAPI\Client\Model\RuleComponent

try {
    $result = $apiInstance->fullUpdateRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->fullUpdateRuleComponent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule component.
project_pk	string
rule_pk	string
ruleset_pk	string
data	\OpenAPI\Client\Model\RuleComponent

Return type

\OpenAPI\Client\Model\RuleComponent

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

fullUpdateRuleset()

fullUpdateRuleset($check_plan_pk, $cloud_pk, $id, $project_pk, $data): \OpenAPI\Client\Model\Ruleset

Update all fields of a Ruleset

Update all fields of a Ruleset Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ruleset.
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\Ruleset(); // \OpenAPI\Client\Model\Ruleset

try {
    $result = $apiInstance->fullUpdateRuleset($check_plan_pk, $cloud_pk, $id, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->fullUpdateRuleset: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this ruleset.
project_pk	string
data	\OpenAPI\Client\Model\Ruleset

Return type

\OpenAPI\Client\Model\Ruleset

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

getChecker()

getChecker($cloud_pk, $id, $ifc_pk, $project_pk): \OpenAPI\Client\Model\IfcChecker

Retrieve a checker of a model

A checker is a link between a checkplan and a model. A checker can launch a check multiple time and store all the results Required scopes: check:read, ifc:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ifc checker.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getChecker($cloud_pk, $id, $ifc_pk, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getChecker: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this ifc checker.
ifc_pk	string
project_pk	string

Return type

\OpenAPI\Client\Model\IfcChecker

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getCheckerResult()

getCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk): \OpenAPI\Client\Model\CheckerResult

Retrieve one CheckerResult

Retrieve one CheckerResult Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$checker_pk = 'checker_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this checker result.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getCheckerResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
checker_pk	string
cloud_pk	string
id	int	A unique integer value identifying this checker result.
ifc_pk	string
project_pk	string

Return type

\OpenAPI\Client\Model\CheckerResult

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getCheckerResults()

getCheckerResults($checker_pk, $cloud_pk, $ifc_pk, $project_pk): \OpenAPI\Client\Model\CheckerResult[]

Retrieve all CheckerResults

Retrieve all CheckerResults Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$checker_pk = 'checker_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getCheckerResults($checker_pk, $cloud_pk, $ifc_pk, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getCheckerResults: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
checker_pk	string
cloud_pk	string
ifc_pk	string
project_pk	string

Return type

\OpenAPI\Client\Model\CheckerResult[]

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getCheckers()

getCheckers($cloud_pk, $ifc_pk, $project_pk): \OpenAPI\Client\Model\IfcChecker[]

Retrieve all checkers of a model

A checker is a link between a checkplan and a model. A checker can launch a check multiple time and store all the results Required scopes: check:read, ifc:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getCheckers($cloud_pk, $ifc_pk, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getCheckers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
ifc_pk	string
project_pk	string

Return type

\OpenAPI\Client\Model\IfcChecker[]

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getCheckplan()

getCheckplan($cloud_pk, $id, $project_pk): \OpenAPI\Client\Model\CheckPlan

Retrieve one Checkplan

Retrieve one Checkplan Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this check plan.
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getCheckplan($cloud_pk, $id, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getCheckplan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this check plan.
project_pk	string

Return type

\OpenAPI\Client\Model\CheckPlan

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getCheckplans()

getCheckplans($cloud_pk, $project_pk): \OpenAPI\Client\Model\CheckPlan[]

Retrieve all Checkplans

Retrieve all Checkplans Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getCheckplans($cloud_pk, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getCheckplans: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
project_pk	string

Return type

\OpenAPI\Client\Model\CheckPlan[]

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getRule()

getRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk): \OpenAPI\Client\Model\Rule

Retrieve one Rule

Retrieve one Rule Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule.
$project_pk = 'project_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string

try {
    $result = $apiInstance->getRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule.
project_pk	string
ruleset_pk	string

Return type

\OpenAPI\Client\Model\Rule

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getRuleComponent()

getRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk): \OpenAPI\Client\Model\RuleComponent

Retrieve one RuleComponent

Retrieve one RuleComponent Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule component.
$project_pk = 'project_pk_example'; // string
$rule_pk = 'rule_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string

try {
    $result = $apiInstance->getRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getRuleComponent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule component.
project_pk	string
rule_pk	string
ruleset_pk	string

Return type

\OpenAPI\Client\Model\RuleComponent

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getRuleComponents()

getRuleComponents($check_plan_pk, $cloud_pk, $project_pk, $rule_pk, $ruleset_pk): \OpenAPI\Client\Model\RuleComponent[]

Retrieve all RuleComponents

Retrieve all RuleComponents Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$rule_pk = 'rule_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string

try {
    $result = $apiInstance->getRuleComponents($check_plan_pk, $cloud_pk, $project_pk, $rule_pk, $ruleset_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getRuleComponents: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
project_pk	string
rule_pk	string
ruleset_pk	string

Return type

\OpenAPI\Client\Model\RuleComponent[]

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getRules()

getRules($check_plan_pk, $cloud_pk, $project_pk, $ruleset_pk): \OpenAPI\Client\Model\Rule[]

Retrieve all Rules

Retrieve all Rules Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string

try {
    $result = $apiInstance->getRules($check_plan_pk, $cloud_pk, $project_pk, $ruleset_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getRules: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
project_pk	string
ruleset_pk	string

Return type

\OpenAPI\Client\Model\Rule[]

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getRuleset()

getRuleset($check_plan_pk, $cloud_pk, $id, $project_pk): \OpenAPI\Client\Model\Ruleset

Retrieve one Ruleset

Retrieve one Ruleset Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ruleset.
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getRuleset($check_plan_pk, $cloud_pk, $id, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getRuleset: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this ruleset.
project_pk	string

Return type

\OpenAPI\Client\Model\Ruleset

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

getRulesets()

getRulesets($check_plan_pk, $cloud_pk, $project_pk): \OpenAPI\Client\Model\Ruleset[]

Retrieve all Rulesets

Retrieve all Rulesets Required scopes: check:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$project_pk = 'project_pk_example'; // string

try {
    $result = $apiInstance->getRulesets($check_plan_pk, $cloud_pk, $project_pk);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->getRulesets: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
project_pk	string

Return type

\OpenAPI\Client\Model\Ruleset[]

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

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

launchNewCheck()

launchNewCheck($cloud_pk, $id, $ifc_pk, $project_pk, $data)

Launch a new check on the model

Starts a new check in the checker Required scopes: check:write, ifc:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ifc checker.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\IfcChecker(); // \OpenAPI\Client\Model\IfcChecker

try {
    $apiInstance->launchNewCheck($cloud_pk, $id, $ifc_pk, $project_pk, $data);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->launchNewCheck: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this ifc checker.
ifc_pk	string
project_pk	string
data	\OpenAPI\Client\Model\IfcChecker

Return type

void (empty response body)

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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

updateChecker()

updateChecker($cloud_pk, $id, $ifc_pk, $project_pk, $data): \OpenAPI\Client\Model\IfcChecker

Update some fields of a checker of a model

A checker is a link between a checkplan and a model. A checker can launch a check multiple time and store all the results Required scopes: check:write, ifc:read

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ifc checker.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\IfcChecker(); // \OpenAPI\Client\Model\IfcChecker

try {
    $result = $apiInstance->updateChecker($cloud_pk, $id, $ifc_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->updateChecker: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this ifc checker.
ifc_pk	string
project_pk	string
data	\OpenAPI\Client\Model\IfcChecker

Return type

\OpenAPI\Client\Model\IfcChecker

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

updateCheckerResult()

updateCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk, $data): \OpenAPI\Client\Model\CheckerResult

Update some fields of a CheckerResult

Update some fields of a CheckerResult Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$checker_pk = 'checker_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this checker result.
$ifc_pk = 'ifc_pk_example'; // string
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\CheckerResult(); // \OpenAPI\Client\Model\CheckerResult

try {
    $result = $apiInstance->updateCheckerResult($checker_pk, $cloud_pk, $id, $ifc_pk, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->updateCheckerResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
checker_pk	string
cloud_pk	string
id	int	A unique integer value identifying this checker result.
ifc_pk	string
project_pk	string
data	\OpenAPI\Client\Model\CheckerResult

Return type

\OpenAPI\Client\Model\CheckerResult

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

updateCheckplan()

updateCheckplan($cloud_pk, $id, $project_pk, $data): \OpenAPI\Client\Model\CheckPlan

Update some fields of a Checkplan

Update some fields of a Checkplan Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this check plan.
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\CheckPlan(); // \OpenAPI\Client\Model\CheckPlan

try {
    $result = $apiInstance->updateCheckplan($cloud_pk, $id, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->updateCheckplan: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_pk	string
id	int	A unique integer value identifying this check plan.
project_pk	string
data	\OpenAPI\Client\Model\CheckPlan

Return type

\OpenAPI\Client\Model\CheckPlan

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

updateRule()

updateRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk, $data): \OpenAPI\Client\Model\Rule

Update some fields of a Rule

Update some fields of a Rule Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule.
$project_pk = 'project_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string
$data = new \OpenAPI\Client\Model\Rule(); // \OpenAPI\Client\Model\Rule

try {
    $result = $apiInstance->updateRule($check_plan_pk, $cloud_pk, $id, $project_pk, $ruleset_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->updateRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule.
project_pk	string
ruleset_pk	string
data	\OpenAPI\Client\Model\Rule

Return type

\OpenAPI\Client\Model\Rule

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

updateRuleComponent()

updateRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk, $data): \OpenAPI\Client\Model\RuleComponent

Update some fields of a RuleComponent

Update some fields of a RuleComponent Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this rule component.
$project_pk = 'project_pk_example'; // string
$rule_pk = 'rule_pk_example'; // string
$ruleset_pk = 'ruleset_pk_example'; // string
$data = new \OpenAPI\Client\Model\RuleComponent(); // \OpenAPI\Client\Model\RuleComponent

try {
    $result = $apiInstance->updateRuleComponent($check_plan_pk, $cloud_pk, $id, $project_pk, $rule_pk, $ruleset_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->updateRuleComponent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this rule component.
project_pk	string
rule_pk	string
ruleset_pk	string
data	\OpenAPI\Client\Model\RuleComponent

Return type

\OpenAPI\Client\Model\RuleComponent

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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

updateRuleset()

updateRuleset($check_plan_pk, $cloud_pk, $id, $project_pk, $data): \OpenAPI\Client\Model\Ruleset

Update some fields of a Ruleset

Update some fields of a Ruleset Required scopes: check:write

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Bearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

// Configure OAuth2 access token for authorization: bimdata_connect
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: client_credentials
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CheckerApi(
    // 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
);
$check_plan_pk = 'check_plan_pk_example'; // string
$cloud_pk = 'cloud_pk_example'; // string
$id = 56; // int | A unique integer value identifying this ruleset.
$project_pk = 'project_pk_example'; // string
$data = new \OpenAPI\Client\Model\Ruleset(); // \OpenAPI\Client\Model\Ruleset

try {
    $result = $apiInstance->updateRuleset($check_plan_pk, $cloud_pk, $id, $project_pk, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckerApi->updateRuleset: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_plan_pk	string
cloud_pk	string
id	int	A unique integer value identifying this ruleset.
project_pk	string
data	\OpenAPI\Client\Model\Ruleset

Return type

\OpenAPI\Client\Model\Ruleset

Authorization

Bearer, bimdata_connect, client_credentials

HTTP request headers

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

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