Share via

Aranda Service Management (Preview)

Boost your company's productivity and transform your users' experience with Aranda Service Management Suite, the multi-tenant solution that allows you to manage, integrate, and automate business processes and services.

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 Aranda Software
URL https://arandasoft.com/
Email [email protected]
Connector Metadata
Publisher Aranda Software Corporation
Website https://arandasoft.com/
Privacy policy https://arandasoft.com/politica-de-privacidad/
Categories Business Management;Collaboration

Aranda Service Management Suite (ASMS)

Boost your company's productivity and transform your users' experience with Aranda Service Management Suite, the multi-tenant solution that allows you to manage, integrate, and automate business processes and services. Create, search, and update records stored in any workspace (project) of ASMS, including incidents, requirements, and changes, among others.

Pre-requisites

Please keep in mind the following pre-requisites to continue:

  • A subscription and an instance of Aranda Service Management Suite (ASMS). Start here: https://arandasoft.com/
  • An active Microsoft Power Automate subscription with Premium connector capabilities.

Obtaining Credentials

  • To perform authentication, use the integration token. In the following link you will find information on how to obtain the integration token

Get started with your connector

  1. Requires a subscription to Aranda Service Management Suite (ASMS).

  2. Obtain the Integration token

  3. Get the Instance URL of the Aranda Service Management ASMS API (ApiAsms).

  4. Establish a connection with the Aranda Service Management Suite connector.

  5. Select one of the following functions offered by the connector:

    Ticket

  6. For detailed documentation around the connector please refer to https://docs.arandasoft.com/connectors

You can use this connector in the following cases:

  1. Create, search, and update tickets, among other actions available.
  2. Obtain ticket traceability.
  3. Download attachments related to a ticket.
  4. Search for knowledge base (KB) articles in Aranda Service Management Suite.
  5. Download attachments from knowledge base (KB) articles.
  6. Create, search and update configuration items (CIs).
  7. It allows organizations to resolve their internal support requests, managing and streamlining the technical problem resolution process.
  8. Allows tracking of communications between requesters and support agents.
  9. Offer automated responses to inform requesters of the status of their ticket.

Successful response

Code Name Description
200 OK The request was successful
204 NoContent No data found in the request

Common errors and remedies

Code Name Description Solution
400 BadRequest CriteriaNeedsSomeArguments Check that the search parameters are not empty
400 BadRequest InvalidAdditionalFieldId Check that the IDs of the additional fields are correct
400 BadRequest InvalidItemType The case type is incorrect, change the case type id
400 BadRequest InvalidProjectId The project id is incorrect, change the project id to which you will associate the case
400 BadRequest InvalidStateId Check the added status when creating or updating a Ticket
400 BadRequest InvalidUploadType An error occurred when attaching a file, Request assistance from a System Administrator
400 BadRequest RequestNeedsSomeArguments Check the required fields of the ticket and add the corresponding value of these in the connector
400 BadRequest SearchListIsRequired Request assistance from a System Administrator
400 BadRequest Parameter Name: {Name parameter} Check that the properties mentioned in the error are not null
400 BadRequest Is null parameter name: {Name parameter} Check that the properties mentioned in the error are not null
400 BadRequest ItemTypeIsRequired Add case type
400 BadRequest ModelIdIsEmpty Add the modelId parameter. It is required.
400 BadRequest StateIdIsEmpty Add the stateId parameter. It is required.
400 BadRequest ServiceIdIsEmpty Add the serviceId parameter. It is required.
400 BadRequest CategoryIdIsEmpty Add the categoryId parameter. It is required.
400 BadRequest TypesListNeedsSomeArguments Requires adding the type of case when searching for tickets, Request assistance from a System Administrator
400 BadRequest '{PARAMETER_NAME}' AdditionalFieldIsRequired The additional field '{PARAMETER_NAME}' is mandatory
400 BadRequest ModelNotActive The model associated with the case is not active
400 BadRequest FailedToCloseTaskPendingCloseTasksPredecessors If you try to close the case and the parent case has pending tasks to close
400 BadRequest DuplicatedObject The Ci already exists in the database
400 BadRequest EmptyValue Parameter name: {PARAMETER_NAME} The {PARAMETER_NAME} parameter is required
400 BadRequest EmptyEnumeration Parameter name: {PARAMETER_NAME} The {PARAMETER_NAME} parameter is a list and is required
403 Forbidden DoNotHavePermissionForThisAction Talk to your System Administrator to assign permissions
Code Name Description Solution
500 InternalServerError Request assistance from a System Administrator
500 InternalServerError FailureExportExcel Request assistance from a System Administrator
500 InternalServerError FailureGetAdditionalFields Request assistance from a System Administrator
500 InternalServerError FailureGetCategoriesByService Request assistance from a System Administrator
500 InternalServerError FailureGetChangeFSC Request assistance from a System Administrator
500 InternalServerError FailureGetFields Request assistance from a System Administrator
500 InternalServerError FailureGetFieldsList Request assistance from a System Administrator
500 InternalServerError FailureGetFiles Request assistance from a System Administrator
500 InternalServerError FailureGetLookupValues Request assistance from a System Administrator
500 InternalServerError FailureGetMailTemplates Request assistance from a System Administrator
500 InternalServerError FailureGetModelByCategory Request assistance from a System Administrator
500 InternalServerError FailureGetOperators Request assistance from a System Administrator
500 InternalServerError FailureGetReassignmentReasons Request assistance from a System Administrator
500 InternalServerError FailureGetSimilarItems Request assistance from a System Administrator
500 InternalServerError FailureSearchQuickManagement Request assistance from a System Administrator

FAQ

  1. How to retrieve the IDs of the attributes required to use the different actions in the connector (e.g. project, service, category, group, specialist)?

    The IDs can be retrieved in many ways:

    • Using Aranda Query Manager, you can create a report that queries the Aranda Service Management Suite (ASMS) table where the required data is located. If you need guidance on the data objects in the solution, visit the following link https://docs.arandasoft.com/docs/database.html and identify the Aranda database version corresponding to your ASMS installation.
    • If you are using an ASMS On Premise installation, you can query the ASMS table where the required data is located through a SQL client.
    • Via Aranda Support Center, creating a support request through the contact channels indicated on the following website Support.

  2. What is the maximum size of files to attach when using the "Add Attachment" action?

    The maximum size depends on the specific configuration of your ASMS instance/installation. Please ask your ASMS Administrator.

  3. What is the data access level required by the technician account whose token is used in the configuration of the ASMS connection required by the connector?

    The access level is the same as the technician account as used in ASMS on a regular basis. In other words, based on the roles and permissions of the corresponding technician in ASMS, the data can be accessed with the connector.

  4. Should the technician account whose token will be used in the connector be Named or Concurrent?

    Since the connector can access the related ASMS instance multiple times per hour, it is strongly recommended that the account be a Named type.

  5. Does the creation or modification of cases using the connector follow the same data validation rules present in the ASMS interface?

    Yes, it follows the same validation rules. For instance, when creating a case for a specific project, service and category, if native and additional fields must be filled in, these data are also required when submitting the case through the connector.

  6. Can the connector be used for ASMS instances in Cloud and On Premise environments?

    Yes, it can be used in both Cloud and On Premise installations of ASMS. In On Premise installations, you must consider the connectivity between the ASMS server and your Power Automate environment.

  7. I have a Power Automate license that only allows me to use Standard connectors. Can I use the ASMS connector?

    It is not possible, the ASMS connector is Premium type.

  8. I want to create flows in Power Automate that start from events in ASMS (e.g. when a case has been created, when a case is assigned to a specific group). Is it possible to use Triggers that start from events occurring in ASMS?

    Yes, it is possible. The following steps are recommended:

    • Initialize a trigger "When a HTTP request is received" and create a Request Body JSON Schema containing the data structure expected to be received from ASMS. Once the trigger is created, you will get an HTTP POST URL (WebHook URL) to use in your ASMS instance. Do not forget to consider the authentication mechanism to access the WebHook URL (e.g. Token).
    • Create a business rule in ASMS for the set of conditions that, when met, should initiate the flow in Power Automate. As an action within the rule, select "Invoke Webhook" and in the invocation destination URL, enter the previously obtained WebHook URL, the parameters to send and the body of the request (which must match the Request Body JSON Schema). For more information on how to invoke a Webhook from a rule in ASMS, visit the following link: Webhook rule
    • Test the created rule and validate an HTTP request is sent to the WebHook URL and initializes the flow in Power Automate.

  9. Can I invoke ASMS REST API endpoints as actions from flows in Power Automate?

    Yes, it is possible. Use the "HTTP" action and fill in the required data in it (URI, Method, Headers, Body, among others).

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Host ASMS string Host ASMS True
Authorization token securestring Authorization token True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add attachment to case

Attach a file to a specific case record in ASMS.
Add note to case

Add a note to a specific case record in ASMS.
Create case

Create a new case record in ASMS.
Create configuration item

Create CIs in the Aranda CMDB.
Download the article attachment

Download attachment related to the article.
Download the case attachment

Download attachment related to the article.
Get case

Gets a record of the metadata of an ASMS case.
Get case history

Get case history, by default notes are not included.
Get configuration item

Get CI by name and serial.
Search articles

Retrieves a list of articles based on the search criteria added in the query.
Search cases

Retrieves a list of ASMS case records depending on the search criteria added in the query.
Search configuration items

Retrieves a list of CMDB CIs records depending on the search criteria added in the query.
Update case

Updates a record for a ASMS case.
Update configuration item

Update CIs in the Aranda CMDB.

Add attachment to case

Operation ID:
AttachFile

Attach a file to a specific case record in ASMS.

Parameters

Name Key Required Type Description
Id by project
 ticketId True string

Code of the record
File
 file True byte

Byte file.
File Name
 fileName True string

File name (e.g 'Vacation_Approval_Form.docx').

Add note to case

Operation ID:
AttachNote

Add a note to a specific case record in ASMS.

Parameters

Name Key Required Type Description
Id by project
 ticketId True string

Code of the record
Note
 message True string

Note to be attached to the record.

Create case

Operation ID:
CreateCase

Create a new case record in ASMS.

Parameters

Name Key Required Type Description
Subject
 subject True string

Subject.
Description
 description string

Detailed description of the case.
Case Type
 itemType True string

Select a case type or enter manually a case type name.
Project
 projectId True integer

Select a project or enter manually a project identifier.
Service
 serviceId True integer

Select a service or enter manually a service identifier.
Category
 categoryId True integer

Select a category or enter manually a category identifier.
Reason
 reasonId integer

Select a reason or enter manually a reason identifier.
Group
 groupId integer

Select a group or enter manually a group identifier.
Responsible
 responsibleId integer

Select a responsible or enter manually a responsible identifier.
Company
 companyId integer

Select a company or enter manually a company identifier.
Provider
 providerId integer

Select a provider or enter manually a provider identifier.
Organizational area
 unitId integer

Select a organizational area or enter manually a organizational area identifier.
Applicant ID
 applicantId integer

Applicant identifier.
Client ID
 customerId integer

Client identifier.
CI identifier
 ciId integer

CI identifier.
Registry type
 registryTypeId integer

Select a registry type or enter manually a registry type identifier.
Urgency
 urgencyId integer

Select a urgency or enter manually a urgency identifier.
Impact
 impactId integer

Select a impact or enter manually a impact identifier.
ID
 fieldId string

Field identifier.
values
 values array of string

Value.

Returns

Name Path Type Description
Case ID
 id integer

Case identifier
Id by project
 idByProject string

Id by project for the record

Create configuration item

Operation ID:
CreateCI

Create CIs in the Aranda CMDB.

Parameters

Name Key Required Type Description
Name
 name True string

Name
Description
 description string

Detailed description of the CI.
Serial
 serial string

Serial.
Asset tag
 assetTag string

Asset tag.
Project
 projectId True integer

Select a project or enter manually a project identifier.
Category
 categoryId True integer

Select a category or enter manually a category identifier.
Responsible ID
 responsibleId True integer

Responsible identifier.
License number
 licenseNumber string

License number.
Manufacturer
 manufacturerId integer

Select a manufacturer or enter manually a manufacturer identifier.
Brand
 brandId integer

Select a brand or enter manually a brand identifier.
Model
 modelId integer

Select a model or enter manually a model identifier.
Provider ID
 providerId integer

Select a provider or enter manually a provider identifier.
Reason ID
 reasonId integer

Reason identifier.
Price
 price number

Price.
RFID
 rfid string

RFID
Acceptance date
 acceptDate date-time

Acceptance date.
Date of delivery to the company
 checkInDate date-time

Date of delivery to the company.
Initial date of responsibility
 responsibilityDate date-time

Initial date of responsibility.
Bar code
 barCode string

Bar code.
Measure unit value
 unitSize string

Measure unit value.
Measure unit
 unitId integer

Select a measure unit or enter manually a measure unit identifier.
Cost center
 costCenterId integer

Select a cost center or enter manually a cost center identifier.
Impact
 impactId integer

Select a impact or enter manually a impact identifier.
Risk
 riskId integer

Select a risk or enter manually a risk identifier.
Location
 locationId integer

Select a location or enter manually a location identifier.
fieldId
 fieldId string

Field identifier.
values
 values array of string

Value

Returns

Name Path Type Description
Configuration item identifier
 id integer

Configuration item identifier.

Download the article attachment

Operation ID:
DownloadArticleFile

Download attachment related to the article.

Parameters

Name Key Required Type Description
Article ID
 articleId True integer

Article identifier.
Attachment ID
 fileId True integer

Represents the identifier of the attachment.

Returns

The content of the attachment.

File content
binary

Download the case attachment

Operation ID:
DownloadCaseFile

Download attachment related to the article.

Parameters

Name Key Required Type Description
Id by project
 ticketId True string

Code of the record
Attachment identifier
 fileId True integer

Represents the identifier of the attachment.

Returns

The content of the attachment.

File content
binary

Get case

Operation ID:
GetCase

Gets a record of the metadata of an ASMS case.

Parameters

Name Key Required Type Description
Id by project
 ticketId True string

Code of the record

Returns

Name Path Type Description
Case ID
 id integer

System identifier for the record.
Id by project
 idByProject string

Id by project for the record.
Subject
 subject string

Subject.
Description
 description string

Detailed description of the case.
Solution
 commentary string

Case solution.
Project ID
 projectId integer

Project identifier.
Project
 projectName string

Project name.
Case type
 itemTypeName string

Case type name.
Case type ID
 itemTypeId integer

Case type identifier.
Service ID
 serviceId integer

Service identifier.
Service
 serviceName string

Service name.
Model ID
 modelId integer

Model identifier.
Model
 modelName string

Model name.
Category ID
 categoryId integer

Category identifier.
Category name
 categoryName string

Category.
Applicant ID
 applicantId integer

Applicant identifier.
Client ID
 customerId integer

Client identifier.
Client
 customerName string

Client name.
Company ID
 companyId integer

Company identifier.
Company
 companyName string

Company name.
CI ID
 ciId integer

CI identifier.
CI
 ciName string

CI name.
SLA ID
 slaId integer

SLA identifier.
SLA
 slaName string

SLA name.
Status ID
 stateId integer

Status identifier.
Status
 stateName string

Status name.
Reason ID
 reasonId integer

Reason identifier.
Reason
 reasonName string

Reason name.
Group ID
 groupId integer

Group identifier.
Group
 groupName string

Group name.
Responsible ID
 responsibleId integer

Responsible identifier.
Responsible
 responsibleName string

Responsible name.
Registry type ID
 registryTypeId integer

Registry type identifier.
Registry type
 registryTypeName string

Registry type name.
Impact ID
 impactId integer

Impact identifier.
Impact
 impactName string

Impact name.
Urgency ID
 urgencyId integer

Urgency identifier.
Urgency
 urgencyName string

Urgency name.
Priority ID
 priorityId integer

Priority identifier.
Priority
 priorityName string

Priority name.
Risk ID
 riskId integer

Risk identifier.
Risk
 riskName string

Risk name.
Provider ID
 providerId integer

Provider identifier.
Provider
 providerName string

Provider name.
UC ID
 ucId integer

UC identifier.
UC
 ucName string

UC name.
Organizational area ID
 unitId integer

Organizational area identifier.
Organizational area
 unitName string

Organizational area name.
OLA ID
 olaId integer

OLA identifier.
OLA
 olaName string

OLA name.
Registry date
 openedDate string

Registry date.
Closed date
 closedDate string

Closed date.
Final date
 finalDate string

Final date (only for Task records).
Initial date
 initialDate string

Initial date (only for Task records).
Costs
 cost number

Costs.
Real cost
 realCost number

Real cost.
Estimated cost
 estimatedCost number

Estimated cost.
Price
 price number

Price.
Interface identifier
 interfaceId string

Interface identifier.
Closed
 isClosed boolean

Closed.
Progress
 currentProgress number

Progress.
Real date
 realDate string

Real date.
Estimated Date
 estimatedDate string

Estimated Date.
Author ID
 authorId integer

Author identifier.
Author
 authorName string

Author name.
Attachments
 attachments array of object

Attachments related to the case.
ID
 attachments.id integer

Attachment identifier.
name
 attachments.name string

Attachment name.
Additional field
 additionalFields array of object

Additional field.
ID
 additionalFields.fieldId integer

field identifier.
name
 additionalFields.nameField string

field name.
values
 additionalFields.values array of string

Additional field values.
: ID
 additionalFields.valueDetails.id integer

Specification for list or catalog type fields: identifier.
: Value
 additionalFields.valueDetails.value string

Specification for list or catalog type fields: Value.

Get case history

Operation ID:
CaseHistory

Get case history, by default notes are not included.

Parameters

Name Key Required Type Description
Id by project
 ticketId True string

Code of the record
Include notes
 addNote string

Select the type of note you want to add.

Returns

Name Path Type Description
array of object
Action key
 actionId string

Action key
Action
 actionName string

Name of the activity or action performed in the ticket life cycle.
Author ID
 authorId integer

Author identifier.
Author
 authorName string

Author who made the change.
Creation date
 created date-time

Date the action occurred.
Modified field name
 fieldName string

Modified field name.
New value
 newValue html

Represents the new value of the property.
Old value
 oldValue html

Value that has been modified.
Note type
 noteType string

Represents the type of note (only for 'Note' Action key).
Related item identifier
 relatedItemId string

Represents the identifier when a Relation is added. (only for 'AddedRelated' Action key).

Get configuration item

Operation ID:
GetCI

Get CI by name and serial.

Parameters

Name Key Required Type Description
Name or Serial CI
 request True string

Enter the name or serial of the configuration item.

Returns

Name Path Type Description
Additional field
 additionalFields array of object

Additional field.
ID
 additionalFields.fieldId integer

field identifier
name
 additionalFields.nameField string

field name
values
 additionalFields.values array of string

Additional field values
: ID
 additionalFields.valueDetails.id integer

Specification for list or catalog type fields: identifier
: Value
 additionalFields.valueDetails.value string

Specification for list or catalog type fields: Value
Asset tag
 assetTag string

Asset tag.
Bar code
 barCode string

Bar code.
ID
 brand.id integer

Brand identifier.
name
 brand.name string

Brand name.
ID
 category.id integer

Category identifier.
name
 category.name string

Category name.
ID
 costCenter.id integer

Cost center identifier.
name
 costCenter.name string

Cost center name.
Acceptance date
 acceptDate date-time

Acceptance date.
Date of delivery to the company
 checkinDate date-time

Date of delivery to the company.
Initial date of responsibility
 responsibilityDate date-time

Initial date of responsibility.
Created date
 createdDate date-time

Created date.
Modified date
 modifiedDate date-time

Modified date.
Description
 description string

Detailed description of the CI.
CI ID
 id integer

System identifier for the record.
ID
 impact.id integer

Impact identifier.
name
 impact.name string

Impact name.
License number
 licenseNumber string

License number.
ID
 manufacturer.id integer

Manufacturer identifier.
name
 manufacturer.name string

Manufacturer name.
ID
 model.id integer

Model identifier.
name
 model.name string

Model name.
CI Name
 name string

Configuration item name.
Projects
 projects array of object

Projects.
ID
 projects.id integer

identifier.
ID
 provider.id integer

Manufacturer identifier.
name
 provider.name string

Manufacturer name.
ID
 reason.id integer

Reason identifier.
name
 reason.name string

Reason name
ID
 responsible.id integer

Responsible identifier.
name
 responsible.name string

Responsible name.
ID
 risk.id integer

Risk identifier.
name
 risk.name string

Risk name.
RFID
 rfid string

RFID
Serial
 serial string

Serial
ID
 state.id integer

State identifier.
name
 state.name string

State name.
Temp item identifier
 tempItemId integer

Temp item identifier.
CI type
 type string

Configuration item type.
ID
 unit.id integer

Unit identifier.
name
 unit.name string

Unit name.
Measure unit value
 unitSize string

Measure unit value.
Useful life
 usefulLife integer

Useful life.
Version
 version integer

version

Search articles

Operation ID:
GetArticle

Retrieves a list of articles based on the search criteria added in the query.

Parameters

Name Key Required Type Description
Project
 projectId True integer

Select a project or enter manually a project identifier.
Search article
 search True string

Search for an article by its title, keyword or description.
Category
 folderId integer

Select a category or enter manually a category identifier.
Type
 typeId integer

Select a type or enter manually a type identifier.

Returns

Name Path Type Description
array of object
Title
 title string

Title.
Description
 description string

Description.
Content
 content html

Content.
Article keyword
 keyword string

Article keyword.
Article ID
 identifier string

Article identifier.
Created date
 createdDate string

Created date.
Modified date
 lastModifiedDate string

Modified date.
Class ID
 classId integer

Class identifier.
Article ID
 id integer

System identifier for the record.
ID
 type.id integer

Type identifier.
name
 type.name string

Type name.
URL
 url string

URL
Attachments article
 attachments array of object

Attachments related to the article.
ID
 attachments.id integer

Attachment identifier.
name
 attachments.name string

Attachment name.

Search cases

Operation ID:
SearchTickets

Retrieves a list of ASMS case records depending on the search criteria added in the query.

Parameters

Name Key Required Type Description
Relation between filters
 logicOperator True string

Specifies the relation between search criteria.
Field to filter
 field True string

Case field to filter (e.g 'stateName').
Search operator
 operator True string

Search operator.
Value to find
 value True string

Field value to find.

Returns

Name Path Type Description
array of object
Case ID
 id integer

System identifier for the record.
Id by project
 idByProject string

Id by project for the record.
Subject
 subject string

Case subject.
Description
 description string

Detailed description of the case.
Project ID
 projectId integer

Project identifier.
Project
 projectName string

Project name.
Case Type
 itemTypeName string

Case type name.
Case type ID
 itemTypeId integer

Case type identifier.
Service ID
 serviceId integer

Service identifier.
Service
 serviceName string

Service name.
Model ID
 modelId integer

Model identifier.
Model
 modelName string

Model name.
Category ID
 categoryId integer

Category identifier.
Category
 categoryName string

Category name.
Applicant ID
 applicantId integer

Applicant identifier.
CI ID
 ciId integer

Configuration item identifier.
CI
 ciName string

Main configuration item name.
Client ID
 customerId integer

Client identifier.
Client
 customerName string

Client name.
Company ID
 companyId integer

Company identifier.
Company
 companyName string

Company name.
SLA ID
 slaId integer

SLA identifier.
SLA
 slaName string

SLA name.
Status ID
 stateId integer

Status identifier.
Status
 stateName string

Status name.
Reason ID
 reasonId integer

Reason identifier.
Reason
 reasonName string

Reason name.
Group ID
 groupId integer

Group identifier.
Group
 groupName string

Group name.
Responsible ID
 responsibleId integer

Responsible identifier.
Responsible
 responsibleName string

Responsible name.
Impact ID
 impactId integer

Impact identifier.
Impact
 impactName string

Impact name.
Registry Date
 openedDate string

Registry Date.
Author ID
 authorId integer

Author identifier.
Author
 authorName string

Author name.

Search configuration items

Operation ID:
SearchCIs

Retrieves a list of CMDB CIs records depending on the search criteria added in the query.

Parameters

Name Key Required Type Description
Relation between filters
 logicOperator True string

Specifies the relation between search criteria.
Field to filter
 field True string

CI field to filter (e.g 'stateName')
Search operator
 operator True string

Search operator.
Value to find
 value True string

Field value to find.

Returns

Name Path Type Description
array of object
Acceptance date
 acceptDate date-time

Acceptance date
Asset tag
 assetTag string

Asset tag
Responsible name
 responsibleName string

Responsible name
ID
 category.id integer

Category identifier
name
 category.name string

Category name
Date of delivery to the company
 checkinDate date-time

Date of delivery to the company.
Created date
 createdDate date-time

Created date
Description
 description string

Detailed description of the CI.
CI ID
 id integer

System identifier for the record.
ID
 impact.id integer

Impact identifier
name
 impact.name string

Impact name
Modified date
 modifiedDate date-time

Modified date
CI Name
 name string

Configuration item name.
Initial date of responsibility
 responsibilityDate date-time

Initial date of responsibility.
Serial
 serial string

Serial
ID
 state.id integer

State identifier.
name
 state.name string

State name.
CI type
 type string

Configuration item type.

Update case

Operation ID:
UpdateCase

Updates a record for a ASMS case.

Parameters

Name Key Required Type Description
Id by project
 ticketId True string

Code of the record
Subject
 subject string

Subject.
Description
 description string

Detailed description of the case.
Solution
 commentary string

Case solution.
Service ID
 serviceId integer

Service identifier.
Category ID
 categoryId integer

Category identifier.
Status ID
 stateId integer

Status identifier.
Reason ID
 reasonId integer

Reason identifier.
Group ID
 groupId integer

Group identifier.
Responsible ID
 responsibleId integer

Responsible identifier.
Applicant ID
 applicantId integer

Applicant identifier.
Client ID
 customerId integer

Client identifier.
Company ID
 companyId integer

Company identifier.
CI ID
 ciId integer

CI identifier.
Provider ID
 providerId integer

Provider identifier.
Organizational area ID
 unitId integer

Organizational area identifier.
Registry type
 registryTypeId integer

Select a registry type or enter manually a registry type identifier.
Urgency
 urgencyId integer

Select a urgency or enter manually a urgency identifier.
Impact
 impactId integer

Select a urgency or enter manually a impact identifier.
Interface
 interfaceId string

relationship of the case with third parties.
Field identifier
 fieldId string

Field identifier.
Values
 values array of string

Values.

Returns

Name Path Type Description
result
 result boolean

Result

Update configuration item

Operation ID:
UpdateCI

Update CIs in the Aranda CMDB.

Parameters

Name Key Required Type Description
Name or Serial CI
 request True string

Enter the name or serial of the configuration item.
Description
 description string

Detailed description of the CI.
Serial
 serial string

Serial
Asset tag
 assetTag string

Asset tag.
Category
 categoryId integer

Select a category or enter manually a category identifier.
Responsible ID
 responsibleId integer

Responsible identifier.
Status ID
 stateId integer

Status identifier.
License number
 licenseNumber string

License number.
Manufacturer ID
 manufacturerId integer

Manufacturer identifier.
Brand
 brandId integer

Select a brand or enter manually a brand identifier.
Model
 modelId integer

Select a model or enter manually a model identifier.
Provider ID
 providerId integer

Provider identifier.
Reason ID
 reasonId integer

Reason identifier.
Price
 price number

Price.
RFID
 rfid string

RFID
Acceptance date
 acceptDate date-time

Acceptance date.
Date of delivery to the company
 checkInDate date-time

Date of delivery to the company.
Initial date of responsibility
 responsibilityDate date-time

Initial date of responsibility.
Bar code
 barCode string

Bar code.
Measure unit value
 unitSize string

Measure unit value.
Measure unit
 unitId integer

Select a measure unit or enter manually a measure unit identifier.
Cost center ID
 costCenterId integer

Cost center identifier.
Impact
 impactId integer

Select a impact or enter manually a impact identifier.
Risk
 riskId integer

Select a risk or enter manually a risk identifier.
Location ID
 locationId integer

Location identifier.
fieldId
 fieldId string

Field identifier
values
 values array of string

Value

Returns

Name Path Type Description
Configuration item identifier
 id integer

Configuration item identifier.

Definitions

binary

This is the basic data type 'binary'.