qurplus/topdesk-asset-management-php-client

dev-master 2019-06-20 11:27 UTC

This package is auto-updated.

Last update: 2020-06-20 14:35:20 UTC


README

此PHP包由OpenAPI Generator项目自动生成

  • API版本: v1.12.0
  • 构建包: org.openapitools.codegen.languages.PhpClientCodegen 更多信息,请访问 http://www.topdesk.com

需求

PHP 7.2 及更高版本

安装 & 使用

Composer

要使用Composer安装绑定,请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装过程进行操作,然后运行以下命令

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



$apiInstance = new Topdesk\AssetManagement\Api\AssetLinksApi(
    // 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()
);
$source_id = 'source_id_example'; // string | The ID of the source asset

try {
    $result = $apiInstance->getLinkedAssets($source_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetLinksApi->getLinkedAssets: ', $e->getMessage(), PHP_EOL;
}

?>

API端点文档

所有URI均相对于 http://http:/tas/api

方法 HTTP请求 描述
AssetLinksApi getLinkedAssets GET /assetmgmt/assetLinks 返回链接的资产。
AssetLinksApi link POST /assetmgmt/assetLinks 将资产链接到目标资产。
AssetLinksApi possibleRelations GET /assetmgmt/assetLinks/possibleRelations 返回源资产和目标资产之间可能关系列表。
AssetLinksApi unlink DELETE /assetmgmt/assetLinks/{relationId} 移除两个资产之间的链接。
AssetManagementImportAPIApi archiveAsset POST /assetmgmt/assets/templateId/{templateId}/{assetId}/archive 存档资产。
AssetManagementImportAPIApi createByImport POST /assetmgmt/assets/templateId/{templateId} 创建新资产。
AssetManagementImportAPIApi getAllAssets GET /assetmgmt/import/assets 返回所有非存档资产的列表。
AssetManagementImportAPIApi getAssets GET /assetmgmt/assets/templateId/{templateId} 返回特定类型的所有资产的列表。
AssetManagementImportAPIApi getCardTypeTemplates GET /assetmgmt/cardTypes 返回所有资产模板的列表。
AssetManagementImportAPIApi getDropdownValues GET /assetmgmt/dropdowns/{dropdownId} 返回给定下拉列表的所有选项。
AssetManagementImportAPIApi getOrCreateDropdownValue POST /assetmgmt/dropdowns/{dropdownId} 检索或创建给定下拉列表的选项。
AssetManagementImportAPIApi modifyByImport PATCH /assetmgmt/assets/templateId/{templateId}/{assetId} 更新现有资产。
AssetManagementImportAPIApi replaceChild PUT /assetmgmt/import/assets/{assetId}/links/child 设置资产的子项。
AssetManagementImportAPIApi replaceIncoming PUT /assetmgmt/import/assets/{assetId}/links/incoming/{linkTypeId} 根据特定链接类型设置资产的依赖关系。
AssetManagementImportAPIApi replaceOutgoing PUT /assetmgmt/import/assets/{assetId}/links/outgoing/{linkTypeId} 根据特定链接类型设置资产的提供链接。
AssetManagementImportAPIApi replaceParent PUT /assetmgmt/import/assets/{assetId}/links/parent 设置资产的父级。
AssetManagementImportAPIApi updateBranchLinks PUT /assetmgmt/assets/templateId/{templateId}/{assetId}/assignment/branches 将分支分配给资产。
AssetManagementImportAPIApi updateLocationLinks PUT /assetmgmt/assets/templateId/{templateId}/{assetId}/assignment/locations 将位置分配给资产。
AssetManagementImportAPIApi updatePersonGroupLinks PUT /assetmgmt/assets/templateId/{templateId}/{assetId}/assignment/personGroups 将人员组分配给资产。
AssetManagementImportAPIApi updatePersonLinks PUT /assetmgmt/assets/templateId/{templateId}/{assetId}/assignment/persons 将人员分配给资产。
AssetsApi archiveAsset POST /assetmgmt/assets/{assetId}/archive 存档资产。
AssetsApi create POST /assetmgmt/assets 创建新资产。
AssetsApi delete POST /assetmgmt/assets/delete 删除多个资产
AssetsApi getAssetById GET /assetmgmt/assets/{assetId} 根据给定的assetId检索资产。
AssetsApi getAssets GET /assetmgmt/assets 返回满足给定条件的资产。
AssetsApi getBlankAsset GET /assetmgmt/assets/blank 根据给定的templateId或templateName检索一个空白、尚未持久化的资产。
AssetsApi getGridFieldValues GET /assetmgmt/assets/getGridFieldValues 获取网格字段的资产。
AssetsApi unarchiveAsset POST /assetmgmt/assets/{assetId}/unarchive 取消归档资产。
AssetsApi update POST /assetmgmt/assets/{assetId} 更新现有资产。
AssignmentsApi assign PUT /assetmgmt/assets/assignments 在位置、人员、分支、事件或人员组与单个资产之间添加分配。
AssignmentsApi assign_0 PUT /assetmgmt/assets/{assetId}/assignments 在位置、人员、分支或人员组与单个资产之间添加分配。
AssignmentsApi getAssignments GET /assetmgmt/assets/{assetId}/assignments 获取资产的分配。
AssignmentsApi removeMultipleAssignments POST /assetmgmt/assets/unlink/{type}/{targetId} 删除指定实体与单个资产之间的链接。
AssignmentsApi unassign DELETE /assetmgmt/assets/{assetId}/assignments/{linkId} 移除已分配的分支、位置、人员或人员组
CapabilitiesApi archiveCapability POST /assetmgmt/capabilities/{capabilityId}/archive 归档功能。
CapabilitiesApi create POST /assetmgmt/capabilities 创建一个新的功能。
CapabilitiesApi get GET /assetmgmt/capabilities 返回所有功能的列表。
CapabilitiesApi getCapability GET /assetmgmt/capabilities/{capabilityId} 返回路径中指定ID的功能。
CapabilitiesApi unarchiveCapability POST /assetmgmt/capabilities/{capabilityId}/unarchive 取消归档功能。
CapabilitiesApi update POST /assetmgmt/capabilities/{capabilityId} 更新现有功能的名称
FieldsApi get GET /assetmgmt/fields/{fieldId} 返回字段的定义。
TemplatesApi getAll GET /assetmgmt/templates 返回所有模板。
UploadsApi callList GET /assetmgmt/uploads 检索给定选择器的已上传blob列表,例如资产。
UploadsApi delete DELETE /assetmgmt/uploads/{uploadId} 删除上传的文档。
UploadsApi upload POST /assetmgmt/uploads 上传一个或多个blob。

模型文档

授权文档

所有端点均不需要授权。

作者

info@topdesk.com