HTTP API please create a Postman workspace

[Martedì]

Hi,

navigating the docs and understand how to compose prefix can be pretty hard, https://docs.axxonsoft.com/confluence/display/one1en/Server+HTTP+API

May I ask if creating a workspace for https://www.postman.com/ where we can set each own variables to get a quick start?

i.e. I'd like to add a bookmark but the following return a 404, so how can I get the correct prefix?

http://{{user}}:{{password}}@{{server_url}}/archive/media/{{server_pc_name}}/DeviceIpint.8/SourceEndpoint.video:0:0/contents/bookmarks/create

[Van Shev]

Hi Martedì
you can configure prefix in Web server settings
https://docs.axxonsoft.com/confluence/display/one20en/Configuring+the+Web-Server

or leave it empty and don't use in API URL

[Martedì]

Thank you Van Shev,  please consider the idea if you share a postman workspace user can set current value of the variables and get up and running in no time.

 

[Van Shev]

Hi Martedi

it's good idea.

I'll think about this.
Thanks

[Martedì]

Hi Van Shev,

may I ask how to retrieve current user default layout?

I share my postman collection as it would be self explanatory.

I can successfully switch layout when I know the id, but in case multiple user should have a different predefined default layout?

is there some trick to pass as id : "defaultuserlayout"?

Thansk, BR

 

axxon.postman_collection.json

[Martedì]

Solved with a trick, named multiple layout as "default user1", "default user2", then shared with users, make a query each time to get the currentid if the name contain default.

BR

[Van Shev]

Hi Martedi
Thank you very much for your explanation

[Martedì]

For anyone interested I share the POSTMAN collection for SERVER HTTP API and gRPC: 

https://cloudy-equinox-591065.postman.co/workspace/Axxon-One-2-HTTP-API~fb1f9582-a1b4-4656-916a-0f4b0bce3cf7/collection/33872513-fd438b1a-cd37-4f81-8936-071c4a02060c?action=share

I’ve added official support email as administrator, with the hope that this will contribute to the documentation growth.

Please note it’s currently a draft, but I trust it could help improve documentation.

Please be aware: in TODO folder you will find request that arent' working (at least for me).

[Aysha So]

New comment

[christopherwright]

One practical improvement for the collection: define a single `{{baseUrl}}` variable that includes scheme, host and API prefix, then use Postman’s Authorization tab for Basic Auth instead of `{{user}}:{{password}}@` in the URL. That makes 404s easier to isolate—if `/archive/media/...` fails, you can compare the prefix without changing credentials. For TODO requests, include the failing URL and status in the request description.