---
title: "ASSAI"
slug: "assai"
updated: 2026-10-27T23:12:43Z
published: 2026-10-27T23:12:43Z
canonical: "ims-handbook.cenosco.com/assai"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://ims-handbook.cenosco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Interfacing with ASSAI

**ASSAI** is a document repository, for which we have an interface created in IMS.

Requests for Assai interface should initially go through the Account Manager.

## Requirements

For Cenosco to be able to provide the User with a working interface the following must be provided by the Client:

- InstanceUrl (eg., [https://*.assaicloud.com/](https://*.assaicloud.com/))
- Username
- Password
- Instance
- ProjectCode

> [!NOTE]
> Important
> 
> It is very important that the provided User is a valid and Active one.
> 
> The User can be provided and checked with the **dedicated Assai Agent**

## Setting up the interface

To do an Assai configuration:

- Go to Maintenance → Configuration → Application Settings.
- Search for “Assai”.

![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-RC4H0Q35.png?sv=2026-02-06&spr=https&st=2026-10-28T14%3A18%3A49Z&se=2026-10-28T15%3A18%3A49Z&sr=c&sp=r&sig=DOZV1wj4OI5AzMcFVpIGXOYVu35YO%2FBnZdUmAUZOvvw%3D)

- Open the **JSON** editor.

![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-49L9E5R5.png?sv=2026-02-06&spr=https&st=2026-10-28T14%3A18%3A49Z&se=2026-10-28T15%3A18%3A49Z&sr=c&sp=r&sig=DOZV1wj4OI5AzMcFVpIGXOYVu35YO%2FBnZdUmAUZOvvw%3D)

- Here the interface can be configured.

![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-5YV5233E.png?sv=2026-02-06&spr=https&st=2026-10-28T14%3A18%3A49Z&se=2026-10-28T15%3A18%3A49Z&sr=c&sp=r&sig=DOZV1wj4OI5AzMcFVpIGXOYVu35YO%2FBnZdUmAUZOvvw%3D)

> [!NOTE]
> Tip
> 
> As the editor itself is pretty clunky JSON can be copy pasted in Notepad ++ and edited there.
> 
> Note that you can use the **Plugins** → **JSTool** →**JSON sort** can help you edit the JSON code in a tidier way.
> 
> ![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-EE5BITM6.png?sv=2026-02-06&spr=https&st=2026-10-28T14%3A18%3A49Z&se=2026-10-28T15%3A18%3A49Z&sr=c&sp=r&sig=DOZV1wj4OI5AzMcFVpIGXOYVu35YO%2FBnZdUmAUZOvvw%3D)

The below data is defined by the User and it has to be correctly set up:

- User needs to be Valid and Active for the drawings to be visible from the IMS side. This part is set by the Client wit their dedicated Assai agent.
- When none of the Assai drawings are visible, in most cases the reason for this is an obsolete User.
- Drawings in Assai are stored under the Project Code and this needs to be correct, so the drawings would be visible to the end user.
- The Project Code needs to be assigned to the User from the Assai/Client side.

![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-FK7WNFMO.png?sv=2026-02-06&spr=https&st=2026-10-28T14%3A18%3A49Z&se=2026-10-28T15%3A18%3A49Z&sr=c&sp=r&sig=DOZV1wj4OI5AzMcFVpIGXOYVu35YO%2FBnZdUmAUZOvvw%3D)

Below you can see what the generic JSON for the interface looks like:

```json
 "InstanceUrl": "",

"Username": "",

"Instance": "",

"Password": "",

"ProjectCode": "",

"EnableFlocSearch": true,

"EnableEqSearch": true,

"DocumentsApi": "/api/views/dbi_document_urls",

"DocumentsQuery": "project_code={Project}&document_nr={Document}&page=0&size=100&response_type=json",

"Fields": {

"Project": "project_code",

"Document": "document_nr",

"Revision": "revision_code",

"Source": "source_file_url",

"Publish": "publish_file_url"

},

"DownloadApi": "/api/fils/download_document",

"DownloadQuery": "?project_code={Project}&document_nr={Document}&revision={Revision}",

"DownloadType": "&filetype=source|&filetype=publish",

"FlocSearchApi": "api/views/dbi_asset_item_docs_proj?document_nr={Document}&project_code={Project}&asset_item_code={Asset}&asset_type=FLOC",

"FlocFields": {

"Document": "document_nr"

},

"EqSapSearchApi": "api/views/dbi_asset_item_docs_proj?document_nr={Document}&project_code={Project}&asset_item_code={Asset}&asset_type=EQPM",

"EqSapFields": {

"Document": "document_nr"
```

## Accessing the repository and adding documents and drawings

See [Accessing ASSAI Drawings and Documents](/v414/docs/accessing-assai-drawings-and-documents).