.png){kind=logo}
Version
- 03 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Version
- Updated on 03 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Version
/v1/version
List the version details of the API.
Notice that all API calls are respecting the Security setting, all exept this call. This is done in order to allow for a mechanisim which can be used to check connection and the availability to the API.
Example for calling:
http://server/v1/version - retrieves the version details of the API
Allowed Methods:
[GET]
API Controller: version
Description:
List relevant version details of the API and connected database.
Request Fields:
There are no request fields for this API.
Response Fields:
| Name | Type | Description | Notes |
|---|---|---|---|
| ApiName | string | Name of the API | |
| ApiDescription | string | Description of the API | |
| ApiBuildDate | string | Date when the API version was build | |
| ApiCompany | string | Company owning the solution | |
| ApiCopyright | string | Copyright details | |
| ApiDllVersion | version[] | Version details | |
| ApiFileVersion | version[] | Version details | |
| DatabaseVersion | version[] | Version details | |
| DatabaseLevel | integer |
Version Details:
| Name | Type | Description | Note |
|---|---|---|---|
| Major | integer | Major version number | |
| Minor | integer | Minor version number | |
| Build | integer | Build version number | |
| Revision | integer | ||
| MajorRevision | integer | ||
| MinorRevision | integer |
Sample JSON Response
[
{
"ApiName": "Safran.Project.Integration.API",
"ApiDescription": "Safran Project Integration API",
"ApiCopyright": "Copyright © 2022",
"ApiCompany": "Safran Software Solutions AS",
"ApiBuildDate": "2022-sep-01",
"ApiDllVersion": {
"Major": 7,
"Minor": 2,
"Build": 0,
"Revision": 9,
"MajorRevision": 0,
"MinorRevision": 9
},
"ApiFileVersion": {
"Major": 7,
"Minor": 2,
"Build": 0,
"Revision": 9,
"MajorRevision": 0,
"MinorRevision": 9
},
"DatabaseVersion": {
"Major": 21,
"Minor": 1,
"Build": 10,
"Revision": 0,
"MajorRevision": 0,
"MinorRevision": 0
},
"DatabaseLevel": 103
}
]
Was this article helpful?