Share via


Aexum (Preview)

Aexum is a Software-as-a-Service for IT Asset Management. Aexum API provides REST endpoints for managing organizations and environments. Manage your own organizational environments, configure customer environments, establish and track partner relationships and administer role-based permission groups across multiple organizations. Secure OAuth2-authenticated API for multi-organizational management. Learn more at https://www.aexum.com

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Aexum
URL https://www.aexum.com
Email aexum@aexum.com
Connector Metadata
Publisher Nodefusion d.o.o
Website https://www.aexum.com
Privacy policy https://www.aexum.com/privacy
Categories Business Management;IT Operations

Nodefusion Aexum Connector

Nodefusion Aexum connector is published here with the intent to provide Nodefusion customers with the actions they already have in Nodefusion Aexum so they can automate their processes.

Publisher: Nodefusion

Prerequisites

Supported Operations

The connector supports the following operations:

Get Version

Get application version

Get Organizations

List your organizations and environments connected to them you have access to.

Obtaining Credentials

You should use your Nodefusion Account when creating PowerApps Connection, the same one you use on Nodefusion Aexum.

Known Issues and Limitations

  • The connector is based on integration with Nodefusion Account accounts.
  • You need to know you organization id or environment id to access other records

Deployment Instructions

Please use these instructions to deploy this connector as custom connector in Microsoft Power Automate and Power Apps.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Assign Asset to Asset Groups

Assign Asset to Asset Groups

Assign Permission Roles to Permission Group

Assign Permission Roles to Permission Group

Assign Users to Organization Role

Assign Users to Organization Role

Assign Users to Permission Group

Assign Users to Permission Group

Assign Users to Team

Assign Users to Team

Assign Vendor to Vendor Groups

Assign Vendor to Vendor Groups

Change Permissions for Permission Role

Change Permissions for Permission Role

Create Asset Assignments

Create Asset Assignments

Create Asset Catalogs

Create Asset Catalogs

Create Asset Connections

Create Asset Connections

Create Asset Group

Create Asset Group

Create Assets

Create Assets

Create Comment

Create Comment

Create Email Template

Create Email Template

Create Feedback

Create Feedback

Create Help Question

Create Help Question

Create Vendor Group

Create Vendor Group

Create Vendors

Create Vendors

Delete Asset Assignments

Delete Asset Assignments

Delete Asset Catalogs

Delete Asset Catalogs

Delete Asset Connections

Delete AssetConnections

Delete Asset Group

Delete Asset Group

Delete Assets

Delete Assets

Delete Business Unit

Delete Business Unit

Delete Comment

Delete Comment

Delete Email Template

Delete Email Template

Delete Environment

Delete Environment

Delete Location

Delete Location

Delete Organization

Delete Organization

Delete Teams

Delete Teams

Delete Vendor Group

Delete Vendor Group

Delete Vendors

Delete Vendors

Get Asset Assignments

Get Asset Assignments

Get Asset Catalog Versions

Get Asset Catalog Versions

Get Asset Catalogs

Get Asset Catalogs

Get Asset Connection Versions

Get Asset Connection Versions

Get Asset Connections

Get Asset Connections

Get Asset Group Versions

Get Asset Group Versions

Get Asset Groups

Get Asset Groups

Get Asset Groups for an Asset

Fetches the groups for a specific asset

Get Asset Versions

Get Asset Versions

Get Assets

Get Assets

Get Assets from Asset Groups

Fetches assets for a list of asset groups

Get Business Unit Versions

Get Business Unit Versions

Get Business Units

Get Business Units

Get Comments

Get Comments

Get Default Email Template

Get Default Email Template

Get Email Template Versions

Get Email Template Versions

Get Email Templates

Get Email Templates

Get Environment Audit Logs

Get Environment Audit Logs with optional metadata (total count and all continuation tokens)

Get Environment Audit Table Names

Get list of audit table names for the environment

Get Environment Settings

Get Environment Settings

Get Environment Users

Get Environment Users

Get Environments

Get Environments

Get Location Versions

Get Location Versions

Get Locations

Get Locations

Get Organization Audit Logs

Get Organization Audit Logs with optional metadata (total count and all continuation tokens)

Get Organization Audit Table Names

Get list of audit table names for the organization

Get Organization Users

Get Organization Users

Get Organizations

Get Organizations

Get Permission Groups

Get Permission Groups

Get Permission Groups for a Permission Role

Fetches the permission groups for a specific permission role

Get Permission Groups for a User

Fetches the permission groups for a specific user

Get Permission Groups Permission Roles

Get Permission Groups Permission Roles

Get Permission Groups Users

Get Permission Groups Users

Get permission mappings

Get permission mappings with ETag support for conditional requests

Get Permission Roles

Get Permission Roles

Get Permissions for Permission Roles

Get Permissions for Permission Roles

Get Team Versions

Get Team Versions

Get Teams

Get Teams

Get Teams for a User

Fetches the teams for a specific user

Get Users from Team

Fetches users for a team

Get Vendor Group Versions

Get Vendor Group Versions

Get Vendor Groups

Get Vendor Groups

Get Vendor Groups for a Vendor

Fetches the groups for a specific vendor

Get Vendor Versions

Get Vendor Versions

Get Vendors

Get Vendors

Get Vendors from Vendor Groups

Fetches vendors for a list of vendor groups

Get Version

Get Version

Patch Asset Assignments

Patch Asset Assignments

Patch Asset Catalogs

Patch Asset Catalogs

Patch Asset Connections

Patch Asset Connections

Patch Asset Groups

Patch Asset Groups

Patch Assets

Patch Assets

Patch Business Units

Patch Business Units

Patch Comment

Patch Comment

Patch Email Template

Patch Email Template

Patch Environment

Patch Environment

Patch Environment Settings

Patch Environment Settings

Patch Locations

Patch Locations

Patch Organization

Patch Organization

Patch Permission Groups

Patch Permission Groups

Patch Permission Roles

Patch Permission Roles

Patch Teams

Patch Teams

Patch Vendor Groups

Patch Vendor Groups

Patch Vendors

Patch Vendors

PostAssign Business Unit

PostAssign Business Unit

PostAssign Environment

PostAssign Environment

PostAssign Location

PostAssign Location

PostAssign Permission Role

PostAssign Permission Role

PostAssign Team

PostAssign Team

Unassign Asset from Asset Groups

Unassign Asset from Asset Groups

Unassign Permission Roles from Permission Group

Unassign Permission Roles from Permission Group

Unassign Users from Organization Role

Unassign Users from Organization Role

Unassign Users from Permission Group

Unassign Users from Permission Group

Unassign Users from Team

Unassign Users from Team

Unassign Vendor from Vendor Groups

Unassign Vendor from Vendor Groups

Assign Asset to Asset Groups

Assign Asset to Asset Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetGroupId
assetGroupId True uuid

The assetGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Assign Permission Roles to Permission Group

Assign Permission Roles to Permission Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

permissionGroupId
permissionGroupId True uuid

The permissionGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Assign Users to Organization Role

Assign Users to Organization Role

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

Organization Permission Role
role True string

Specify the organization permission role: Owner, Manager, Member, or Viewer

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Assign Users to Permission Group

Assign Users to Permission Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

permissionGroupId
permissionGroupId True uuid

The permissionGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Assign Users to Team

Assign Users to Team

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

teamId
teamId True uuid

The teamId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Assign Vendor to Vendor Groups

Assign Vendor to Vendor Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

vendorGroupId
vendorGroupId True uuid

The vendorGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Change Permissions for Permission Role

Change Permissions for Permission Role

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Change Assignment Action
action string

Specify the assignment action: Assign or Unassign

permissionRoleId
permissionRoleId True string

The permissionRoleId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body string

Returns

Create Asset Assignments

Create Asset Assignments

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

AssetId
AssetId uuid
UserId
UserId uuid
TeamId
TeamId uuid
PeriodStart
PeriodStart date-time
PeriodEnd
PeriodEnd date-time
AssetAssignmentType
AssetAssignmentType string

Returns

Name Path Type Description
array of uuid

Create Asset Catalogs

Create Asset Catalogs

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Name
Name True string
AssetType
AssetType string
ManufacturerVendorId
ManufacturerVendorId uuid
DefaultSupplierVendorId
DefaultSupplierVendorId uuid
DefaultWarrantyVendorId
DefaultWarrantyVendorId uuid
SKU
SKU string
EAN
EAN string
TarriffNumber
TarriffNumber string
CountryOfOrigin
CountryOfOrigin string
Description
Description string

Returns

Name Path Type Description
array of uuid

Create Asset Connections

Create Asset Connections

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Asset1Id
Asset1Id uuid
Asset2Id
Asset2Id uuid
Asset3Id
Asset3Id uuid
AssetConnectionType
AssetConnectionType string
Description
Description string

Returns

Name Path Type Description
array of uuid

Create Asset Group

Create Asset Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

ParentAssetGroupId
ParentAssetGroupId True uuid
Name
Name True string
Description
Description string

Returns

Name Path Type Description
array of uuid

Create Assets

Create Assets

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Name
Name True string
AssetCatalogId
AssetCatalogId uuid
LocationId
LocationId uuid
BusinessUnitId
BusinessUnitId uuid
ParentAssetId
ParentAssetId uuid
SupplierVendorId
SupplierVendorId uuid
WarrantyVendorId
WarrantyVendorId uuid
SerialNumber
SerialNumber string
ERPCode
ERPCode string
WarrantyStartDate
WarrantyStartDate date-time
WarrantyEndDate
WarrantyEndDate date-time
Description
Description string

Returns

Name Path Type Description
array of uuid

Create Comment

Create Comment

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

entity
entity True string

The entity parameter

entityId
entityId True uuid

The entityId parameter

Content
Content True string

Returns

Create Email Template

Create Email Template

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Subject
Subject True string
Body
Body True string
Language
Language True string
Type
Type string
IsDefault
IsDefault boolean

Returns

Name Path Type Description
array of uuid

Create Feedback

Create Feedback

Parameters

Name Key Required Type Description
Subject
Subject True string
Body
Body True string
Url
Url True string
FrontendVersion
FrontendVersion True string
BrowserVersion
BrowserVersion True string
UserEmail
UserEmail True string
UserDisplayName
UserDisplayName True string
UserObjectId
UserObjectId uuid

Returns

Create Help Question

Create Help Question

Parameters

Name Key Required Type Description
ThreadId
ThreadId string
UserMessage
UserMessage string
PageUrl
PageUrl string

Returns

Create Vendor Group

Create Vendor Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

ParentVendorGroupId
ParentVendorGroupId True uuid
Name
Name True string
Description
Description string

Returns

Name Path Type Description
array of uuid

Create Vendors

Create Vendors

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Name
Name True string
ParentVendorId
ParentVendorId uuid
Address1
Address1 string
Address2
Address2 string
AddressPostalCode
AddressPostalCode string
AddressCity
AddressCity string
AddressCountry
AddressCountry string
ERPCode
ERPCode string
VATId
VATId string
Description
Description string

Returns

Name Path Type Description
array of uuid

Delete Asset Assignments

Delete Asset Assignments

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Asset Catalogs

Delete Asset Catalogs

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Asset Connections

Delete AssetConnections

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Asset Group

Delete Asset Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Assets

Delete Assets

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Business Unit

Delete Business Unit

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Comment

Delete Comment

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

entity
entity True string

The entity parameter

entityId
entityId True uuid

The entityId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Email Template

Delete Email Template

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Environment

Delete Environment

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Location

Delete Location

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Organization

Delete Organization

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

Returns

Delete Teams

Delete Teams

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Vendor Group

Delete Vendor Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Delete Vendors

Delete Vendors

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Assignments

Get Asset Assignments

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Catalog Versions

Get Asset Catalog Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetCatalogVersionIds
assetCatalogVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Catalogs

Get Asset Catalogs

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Connection Versions

Get Asset Connection Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetConnectionVersionIds
assetConnectionVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Connections

Get Asset Connections

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Group Versions

Get Asset Group Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetGroupVersionIds
assetGroupVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Groups

Get Asset Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Groups for an Asset

Fetches the groups for a specific asset

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetId
assetId True uuid

The assetId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Asset Versions

Get Asset Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetVersionIds
assetVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Assets

Get Assets

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Assets from Asset Groups

Fetches assets for a list of asset groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetGroupId
assetGroupId True uuid

The assetGroupId parameter

Selection Filter
selectionFilterIncluded string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Business Unit Versions

Get Business Unit Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

businessUnitVersionIds
businessUnitVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Business Units

Get Business Units

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Comments

Get Comments

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

entity
entity True string

The entity parameter

entityId
entityId True uuid

The entityId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Default Email Template

Get Default Email Template

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Email Template Type
emailTemplateType True string

Specify the type of email template: AssetAssignment or AssetReturn

language
language True string

The language parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Email Template Versions

Get Email Template Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

emailTemplateVersionIds
emailTemplateVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Email Templates

Get Email Templates

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Environment Audit Logs

Get Environment Audit Logs with optional metadata (total count and all continuation tokens)

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

tableName
tableName True string

The tableName parameter

UserId
UserId uuid

The UserId parameter

EntityId
EntityId string

The EntityId parameter

ChangeType
ChangeType string

The ChangeType parameter

PageSize
PageSize integer

The PageSize parameter

ContinuationToken
ContinuationToken string

The ContinuationToken parameter

IncludeMetadata
IncludeMetadata boolean

The IncludeMetadata parameter

Returns

Get Environment Audit Table Names

Get list of audit table names for the environment

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Returns

Name Path Type Description
array of string

Get Environment Settings

Get Environment Settings

Parameters

Name Key Required Type Description
environmentId
environmentId True string

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Environment Users

Get Environment Users

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Environments

Get Environments

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

organizationId
organizationId uuid

The organizationId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Location Versions

Get Location Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

locationVersionIds
locationVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Locations

Get Locations

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Organization Audit Logs

Get Organization Audit Logs with optional metadata (total count and all continuation tokens)

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

tableName
tableName True string

The tableName parameter

UserId
UserId uuid

The UserId parameter

EntityId
EntityId string

The EntityId parameter

ChangeType
ChangeType string

The ChangeType parameter

PageSize
PageSize integer

The PageSize parameter

ContinuationToken
ContinuationToken string

The ContinuationToken parameter

IncludeMetadata
IncludeMetadata boolean

The IncludeMetadata parameter

Returns

Get Organization Audit Table Names

Get list of audit table names for the organization

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

Returns

Name Path Type Description
array of string

Get Organization Users

Get Organization Users

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

Organization Permission Role
role string

Specify the organization permission role: Owner, Manager, Member, or Viewer

hasRole
hasRole boolean

The hasRole parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Organizations

Get Organizations

Parameters

Name Key Required Type Description
$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Permission Groups

Get Permission Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Permission Groups for a Permission Role

Fetches the permission groups for a specific permission role

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

permissionRoleId
permissionRoleId True uuid

The permissionRoleId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Permission Groups for a User

Fetches the permission groups for a specific user

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

userId
userId True uuid

The userId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Permission Groups Permission Roles

Get Permission Groups Permission Roles

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

permissionGroupId
permissionGroupId True uuid

The permissionGroupId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Permission Groups Users

Get Permission Groups Users

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

permissionGroupId
permissionGroupId True uuid

The permissionGroupId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get permission mappings

Get permission mappings with ETag support for conditional requests

Returns

response
object

Get Permission Roles

Get Permission Roles

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Permissions for Permission Roles

Get Permissions for Permission Roles

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

permissionRoleId
permissionRoleId True string

The permissionRoleId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Name Path Type Description
array of string

Get Team Versions

Get Team Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

teamVersionIds
teamVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Teams

Get Teams

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Teams for a User

Fetches the teams for a specific user

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

userId
userId True uuid

The userId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Users from Team

Fetches users for a team

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

teamId
teamId True uuid

The teamId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Vendor Group Versions

Get Vendor Group Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

vendorGroupVersionIds
vendorGroupVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Vendor Groups

Get Vendor Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Vendor Groups for a Vendor

Fetches the groups for a specific vendor

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

vendorId
vendorId True uuid

The vendorId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Vendor Versions

Get Vendor Versions

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

vendorVersionIds
vendorVersionIds uuid

Filter the results using OData syntax.

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Vendors

Get Vendors

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Vendors from Vendor Groups

Fetches vendors for a list of vendor groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

vendorGroupId
vendorGroupId True uuid

The vendorGroupId parameter

Selection Filter
selectionFilter string

Specify whether to include or exclude items based on the filter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

Returns

Get Version

Get Version

Returns

response
string

Patch Asset Assignments

Patch Asset Assignments

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

AssetAssignmentId
AssetAssignmentId uuid
AssetId
AssetId uuid
UserId
UserId uuid
TeamId
TeamId uuid
PeriodStart
PeriodStart date-time
PeriodEnd
PeriodEnd date-time
AssetAssignmentType
AssetAssignmentType string

Returns

Patch Asset Catalogs

Patch Asset Catalogs

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

AssetCatalogId
AssetCatalogId uuid
Name
Name string
ManufacturerVendorId
ManufacturerVendorId uuid
DefaultSupplierVendorId
DefaultSupplierVendorId uuid
DefaultWarrantyVendorId
DefaultWarrantyVendorId uuid
SKU
SKU string
EAN
EAN string
TarriffNumber
TarriffNumber string
CountryOfOrigin
CountryOfOrigin string
Description
Description string

Returns

Patch Asset Connections

Patch Asset Connections

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

AssetConnectionId
AssetConnectionId uuid
AssetConnectionType
AssetConnectionType string
Asset1Id
Asset1Id uuid
Asset2Id
Asset2Id uuid
Asset3Id
Asset3Id uuid
Description
Description string

Returns

Patch Asset Groups

Patch Asset Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

AssetGroupId
AssetGroupId True uuid
ParentAssetGroupId
ParentAssetGroupId True uuid
Name
Name True string
Description
Description string

Returns

Patch Assets

Patch Assets

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

AssetId
AssetId uuid
ParentAssetId
ParentAssetId uuid
SupplierVendorId
SupplierVendorId uuid
WarrantyVendorId
WarrantyVendorId uuid
LocationId
LocationId uuid
BusinessUnitId
BusinessUnitId uuid
AssetCatalogId
AssetCatalogId uuid
WarrantyStartDate
WarrantyStartDate date-time
WarrantyEndDate
WarrantyEndDate date-time
Name
Name string
Description
Description string
SerialNumber
SerialNumber string
ERPCode
ERPCode string

Returns

Patch Business Units

Patch Business Units

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

BusinessUnitId
BusinessUnitId True uuid
ParentBusinessUnitId
ParentBusinessUnitId True uuid
Name
Name True string
Description
Description string

Returns

Patch Comment

Patch Comment

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

entity
entity True string

The entity parameter

entityId
entityId True uuid

The entityId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

CommentId
CommentId uuid
Content
Content True string

Returns

Patch Email Template

Patch Email Template

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

EmailTemplateId
EmailTemplateId True uuid
Subject
Subject True string
Body
Body True string
IsDefault
IsDefault True boolean

Returns

Name Path Type Description
array of uuid

Patch Environment

Patch Environment

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

EnvironmentId
EnvironmentId True uuid
Name
Name True string

Returns

Patch Environment Settings

Patch Environment Settings

Parameters

Name Key Required Type Description
environmentId
environmentId True string

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

FromEmailAddress
FromEmailAddress string
MicrosoftGraphUserMailbox
MicrosoftGraphUserMailbox string
MicrosoftGraphSaveToSentItems
MicrosoftGraphSaveToSentItems boolean
MicrosoftTenantId
MicrosoftTenantId string
EmailProvider
EmailProvider string
SMTPServer
SMTPServer string
SMTPPort
SMTPPort integer
SMTPUsername
SMTPUsername string
SMTPPassword
SMTPPassword string
SMTPEnableSSL
SMTPEnableSSL boolean

Returns

Patch Locations

Patch Locations

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

LocationId
LocationId True uuid
ParentLocationId
ParentLocationId True uuid
Name
Name True string
Description
Description string
Address1
Address1 string
Address2
Address2 string
AddressCity
AddressCity string
AddressPostalCode
AddressPostalCode string
AddressCountry
AddressCountry string

Returns

Patch Organization

Patch Organization

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

OrganizationId
OrganizationId True uuid
Name
Name True string

Returns

Patch Permission Groups

Patch Permission Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

PermissionGroupId
PermissionGroupId True uuid
Name
Name True string
Description
Description string

Returns

Patch Permission Roles

Patch Permission Roles

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

PermissionRoleId
PermissionRoleId True uuid
Name
Name True string
Description
Description string

Returns

Patch Teams

Patch Teams

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

TeamId
TeamId uuid
Name
Name True string
Description
Description string

Returns

Patch Vendor Groups

Patch Vendor Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

VendorGroupId
VendorGroupId True uuid
ParentVendorGroupId
ParentVendorGroupId True uuid
Name
Name True string
Description
Description string

Returns

Patch Vendors

Patch Vendors

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

VendorId
VendorId uuid
Name
Name string
ParentVendorId
ParentVendorId uuid
Address1
Address1 string
Address2
Address2 string
AddressPostalCode
AddressPostalCode string
AddressCity
AddressCity string
AddressCountry
AddressCountry string
ERPCode
ERPCode string
VATId
VATId string
Description
Description string
VendorGroupId
VendorGroupId uuid

Returns

PostAssign Business Unit

PostAssign Business Unit

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

ParentBusinessUnitId
ParentBusinessUnitId True uuid
Name
Name True string
Description
Description string

Returns

PostAssign Environment

PostAssign Environment

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

OrganizationId
OrganizationId True uuid
Name
Name True string

Returns

PostAssign Location

PostAssign Location

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

ParentLocationId
ParentLocationId True uuid
Name
Name True string
Description
Description string
Address1
Address1 string
Address2
Address2 string
AddressCity
AddressCity string
AddressPostalCode
AddressPostalCode string
AddressCountry
AddressCountry string

Returns

Name Path Type Description
array of uuid

PostAssign Permission Role

PostAssign Permission Role

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

body
body array of string

Returns

Name Path Type Description
array of uuid

PostAssign Team

PostAssign Team

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

Name
Name True string
Description
Description string

Returns

Name Path Type Description
array of uuid

Unassign Asset from Asset Groups

Unassign Asset from Asset Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

assetGroupId
assetGroupId True uuid

The assetGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Unassign Permission Roles from Permission Group

Unassign Permission Roles from Permission Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

permissionGroupId
permissionGroupId True uuid

The permissionGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Unassign Users from Organization Role

Unassign Users from Organization Role

Parameters

Name Key Required Type Description
organizationId
organizationId True uuid

The organizationId parameter

Organization Permission Role
role True string

Specify the organization permission role: Owner, Manager, Member, or Viewer

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Unassign Users from Permission Group

Unassign Users from Permission Group

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

permissionGroupId
permissionGroupId True uuid

The permissionGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Unassign Users from Team

Unassign Users from Team

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

teamId
teamId True uuid

The teamId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Unassign Vendor from Vendor Groups

Unassign Vendor from Vendor Groups

Parameters

Name Key Required Type Description
environmentId
environmentId True uuid

The environmentId parameter

vendorGroupId
vendorGroupId True uuid

The vendorGroupId parameter

$filter
$filter string

Filter the results using OData syntax. Example: Name eq 'Asset1' or contains(Name,'Laptop')

$orderby
$orderby string

Sort the results using OData syntax. Example: Name desc or CreatedAt asc

$top
$top integer

Limit the number of items returned (default: 100, max: 10000)

$skip
$skip integer

Skip a number of items for pagination

$count
$count boolean

Include the total count of items in the X-Total-Count response header

$select
$select string

Select specific properties to return. Example: AssetId,Name,CreatedAt

body
body array of uuid

Returns

Definitions

AIHelpResponse

Name Path Type Description
ThreadId
ThreadId string
AgentMessage
AgentMessage string
IsNewThread
IsNewThread boolean

AexumOrganizationRegion

AssetAssignmentDetailsResponse

Name Path Type Description
AssetAssignmentId
AssetAssignmentId uuid
AssetId
AssetId uuid
UserId
UserId uuid
TeamId
TeamId uuid
AssetAssignmentType
AssetAssignmentType AssetAssignmentType
AssetName
AssetName string
UserName
UserName string
TeamName
TeamName string
PeriodStart
PeriodStart date-time
PeriodEnd
PeriodEnd date-time
AssignedToId
AssignedToId uuid
AssignedToType
AssignedToType string
AssignedToName
AssignedToName string

AssetAssignmentType

AssetCatalogDetailsResponse

Name Path Type Description
AssetCatalogId
AssetCatalogId uuid
ManufacturerVendorId
ManufacturerVendorId uuid
DefaultSupplierVendorId
DefaultSupplierVendorId uuid
DefaultWarrantyVendorId
DefaultWarrantyVendorId uuid
Name
Name string
ManufacturerVendorName
ManufacturerVendorName string
DefaultSupplierVendorName
DefaultSupplierVendorName string
DefaultWarrantyVendorName
DefaultWarrantyVendorName string
AssetType
AssetType AssetType
SKU
SKU string
EAN
EAN string
TarriffNumber
TarriffNumber string
CountryOfOrigin
CountryOfOrigin string
Description
Description string
DeletedState
DeletedState DeletedState

AssetCatalogVersionResponse

Name Path Type Description
AssetCatalogVersionId
AssetCatalogVersionId uuid
AssetCatalogId
AssetCatalogId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

AssetConnectionDetailsResponse

Name Path Type Description
AssetConnectionId
AssetConnectionId uuid
Asset1Id
Asset1Id uuid
Asset2Id
Asset2Id uuid
Asset3Id
Asset3Id uuid
AssetConnectionType
AssetConnectionType AssetConnectionType
Asset1Name
Asset1Name string
Asset2Name
Asset2Name string
Asset3Name
Asset3Name string
Description
Description string
DeletedState
DeletedState DeletedState

AssetConnectionType

AssetConnectionVersionResponse

Name Path Type Description
AssetConnectionVersionId
AssetConnectionVersionId uuid
AssetConnectionId
AssetConnectionId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

AssetDetailsWithAssignmentResponse

Name Path Type Description
AssetId
AssetId uuid
AssetCatalogId
AssetCatalogId uuid
ParentAssetId
ParentAssetId uuid
LocationId
LocationId uuid
BusinessUnitId
BusinessUnitId uuid
Name
Name string
SerialNumber
SerialNumber string
ParentAssetName
ParentAssetName string
LocationName
LocationName string
BusinessUnitName
BusinessUnitName string
SupplierVendorName
SupplierVendorName string
WarrantyVendorName
WarrantyVendorName string
AssetCatalogName
AssetCatalogName string
SupplierVendorId
SupplierVendorId uuid
WarrantyVendorId
WarrantyVendorId uuid
Description
Description string
ERPCode
ERPCode string
AssetType
AssetType AssetType
DeletedState
DeletedState DeletedState
WarrantyEndDate
WarrantyEndDate date-time
WarrantyStartDate
WarrantyStartDate date-time
AssignedToId
AssignedToId uuid
AssignedToType
AssignedToType string
AssignedToName
AssignedToName string

AssetGroupDetailsResponse

Name Path Type Description
AssetGroupId
AssetGroupId uuid
ParentAssetGroupId
ParentAssetGroupId uuid
Name
Name string
ParentAssetGroupName
ParentAssetGroupName string
Description
Description string
DeletedState
DeletedState DeletedState

AssetGroupResponse

Name Path Type Description
AssetGroupId
AssetGroupId uuid
ParentAssetGroupId
ParentAssetGroupId uuid
Name
Name string

AssetGroupVersionResponse

Name Path Type Description
AssetGroupVersionId
AssetGroupVersionId uuid
AssetGroupId
AssetGroupId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

AssetType

AssetVersionResponse

Name Path Type Description
AssetVersionId
AssetVersionId uuid
AssetId
AssetId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

AuditLogsPagedResponse

Name Path Type Description
Logs
Logs array of AuditLogsResponse
ContinuationToken
ContinuationToken string
TotalCount
TotalCount integer
AllContinuationTokens
AllContinuationTokens array of string

AuditLogsResponse

Name Path Type Description
Timestamp
Timestamp date-time
EntityType
EntityType string
EntityId
EntityId string
ChangedBy
ChangedBy string
ChangeType
ChangeType string
NewValues
NewValues string
OldValues
OldValues string

BusinessUnitDetailsResponse

Name Path Type Description
BusinessUnitId
BusinessUnitId uuid
ParentBusinessUnitId
ParentBusinessUnitId uuid
Name
Name string
ParentDisplayName
ParentDisplayName string
Description
Description string
DeletedState
DeletedState DeletedState

BusinessUnitVersionResponse

Name Path Type Description
BusinessUnitVersionId
BusinessUnitVersionId uuid
BusinessUnitId
BusinessUnitId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

CommentResponse

Name Path Type Description
CommentId
CommentId uuid
Content
Content string
Entity
Entity string
EntityId
EntityId uuid
ModifiedOn
ModifiedOn date-time
modifiedBy
modifiedBy UserInfo
CreatedOn
CreatedOn date-time
createdBy
createdBy UserInfo
DeletedState
DeletedState DeletedState

DeletedState

EmailTemplateDetailsResponse

Name Path Type Description
EmailTemplateId
EmailTemplateId uuid
EnvironmentId
EnvironmentId uuid
Subject
Subject string
Body
Body string
Language
Language string
Type
Type EmailTemplateType
IsDefault
IsDefault boolean
CreatedBy
CreatedBy uuid
ModifiedBy
ModifiedBy uuid
CreatedOn
CreatedOn date-time
ModifiedOn
ModifiedOn date-time
DeletedState
DeletedState DeletedState

EmailTemplateType

EmailTemplateVersionResponse

Name Path Type Description
EmailTemplateVersionId
EmailTemplateVersionId uuid
EmailTemplateId
EmailTemplateId uuid
EnvironmentId
EnvironmentId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
Subject
Subject string
Body
Body string
Language
Language string
Type
Type EmailTemplateType
CreatedByDisplayName
CreatedByDisplayName string

EnvironmentResponse

Name Path Type Description
EnvironmentId
EnvironmentId uuid
OrganizationId
OrganizationId uuid
Name
Name string
DeletedState
DeletedState DeletedState

EnvironmentSettingEmailProvider

EnvironmentSettingResponse

Name Path Type Description
EnvironmentSettingId
EnvironmentSettingId uuid
EnvironmentId
EnvironmentId uuid
FromEmailAddress
FromEmailAddress string
MicrosoftGraphUserMailbox
MicrosoftGraphUserMailbox string
MicrosoftGraphSaveToSentItems
MicrosoftGraphSaveToSentItems boolean
MicrosoftTenantId
MicrosoftTenantId string
EmailProvider
EmailProvider EnvironmentSettingEmailProvider
SMTPServer
SMTPServer string
SMTPPort
SMTPPort integer
SMTPUsername
SMTPUsername string
SMTPPassword
SMTPPassword string
SMTPEnableSSL
SMTPEnableSSL boolean

LocationDetailsResponse

Name Path Type Description
LocationId
LocationId uuid
ParentLocationId
ParentLocationId uuid
Name
Name string
ParentDisplayName
ParentDisplayName string
Description
Description string
Address1
Address1 string
Address2
Address2 string
AddressCity
AddressCity string
AddressPostalCode
AddressPostalCode string
AddressCountry
AddressCountry string
DeletedState
DeletedState DeletedState

LocationVersionDetailsResponse

Name Path Type Description
LocationVersionId
LocationVersionId uuid
LocationId
LocationId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string
ParentDisplayName
ParentDisplayName string
ParentLocationId
ParentLocationId uuid
DeletedState
DeletedState DeletedState
Name
Name string
Address1
Address1 string
Address2
Address2 string
AddressCity
AddressCity string
AddressPostalCode
AddressPostalCode string
AddressCountry
AddressCountry string
Description
Description string

MessageResponse

Name Path Type Description
Message
Message string

OrganizationResponse

Name Path Type Description
OrganizationId
OrganizationId uuid
Name
Name string
DeletedState
DeletedState DeletedState
CreatedOn
CreatedOn date-time
Country
Country string
AexumOrganizationRegion
AexumOrganizationRegion AexumOrganizationRegion
EnvironmentsResponse
EnvironmentsResponse object

PermissionGroupDetailsResponse

Name Path Type Description
Name
Name string
PermissionGroupId
PermissionGroupId uuid
Description
Description string

PermissionRoleDetailsResponse

Name Path Type Description
Name
Name string
PermissionRoleId
PermissionRoleId uuid
Description
Description string

TeamDetailsResponse

Name Path Type Description
TeamId
TeamId uuid
Name
Name string
Description
Description string

TeamVersionResponse

Name Path Type Description
TeamVersionId
TeamVersionId uuid
TeamId
TeamId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

UserInfo

Name Path Type Description
UserId
UserId uuid
DisplayName
DisplayName string
Email
Email string

UserResponse

Name Path Type Description
UserId
UserId uuid
DisplayName
DisplayName string
Email
Email string
DeletedState
DeletedState DeletedState

VendorDetailsResponse

Name Path Type Description
VendorId
VendorId uuid
Name
Name string
ParentVendorId
ParentVendorId uuid
ParentVendorName
ParentVendorName string
Address1
Address1 string
Address2
Address2 string
AddressPostalCode
AddressPostalCode string
AddressCity
AddressCity string
AddressCountry
AddressCountry string
ERPCode
ERPCode string
VATId
VATId string
Description
Description string
DeletedState
DeletedState DeletedState

VendorGroupDetailsResponse

Name Path Type Description
VendorGroupId
VendorGroupId uuid
ParentVendorGroupId
ParentVendorGroupId uuid
Name
Name string
ParentVendorGroupName
ParentVendorGroupName string
Description
Description string
DeletedState
DeletedState DeletedState

VendorGroupResponse

Name Path Type Description
VendorGroupId
VendorGroupId uuid
ParentVendorGroupId
ParentVendorGroupId uuid
Name
Name string

VendorGroupVersionResponse

Name Path Type Description
VendorGroupVersionId
VendorGroupVersionId uuid
VendorGroupId
VendorGroupId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

VendorVersionResponse

Name Path Type Description
VendorVersionId
VendorVersionId uuid
VendorId
VendorId uuid
CreatedBy
CreatedBy uuid
CreatedOn
CreatedOn date-time
CreatedByDisplayName
CreatedByDisplayName string

object

This is the type 'object'.

string

This is the basic data type 'string'.