GSD Net frame api API documentation

/rest/opendocuframedb

/rest/opendocuframedb

/rest/opendocuframedb

Method that opens DOCUframe.

Request
Response

Body
Media type: application/json
Type: object
Properties:
- rashost: string (required)
  Remote access server address
- dbshost: string (required)
  Database address
- dbname: string (required)
  Database name
- username: string (required)
  User name
- userpwhash: string (required)
  Password, encrypted in MD5
- timeout: number (required)
  Timeout
- readtimeout: number (required)
  Read timeout
Example
```
{
  "rashost": "your remoce access server host",
  "dbshost": "your database host",
  "dbname": "your database name",
  "username": "your user name",
  "userpwhash": "your password",
  "timeout": 3000,
  "readtimeout": 3000
}
```

Body
Media type: application/json
Type: object
Properties
- status: number (required)
  Response status code
- data: object (required)
  Response data in this case session id
Example
```
{
  "retcode": 200,
  "data": "7691a637-b48f-487a-bbb1-202b7c55ss21"
}
```

/rest/openerpframedb

/rest/openerpframedb

/rest/openerpframedb

Method that opens ERPframe.

Request
Response

Body
Media type: application/json
Possible types:
- OpenERPframeDB
  - rashost: string (required)
    Remote access server address
  - username: string (required)
    User name
  - userpwhash: string (required)
    Password, encrypted in MD5
  - clientname: string (required)
    Client name
  - appcontext: number (required)
    Application context
  - timeout: number (required)
    Timeout
  - readtimeout: number (required)
    Read timeout
  - parameters: (array of ERPParameterTO)
    Items: ERPParameterTO
    name: string (required)
    Name
    type: (one of N, C, L, U)
    Indicates what is the type of field value
    
    id Description
    N Number
    C String
    L Boolean
    U Nested ERPParameterTO value
    value: string (required)
    Value of type depending on provided enum type, may contain number or string or boolean or nested ERPParameterTO object or array of ERPParameterTO objects
- OpenERPframeDB
  - rashost: string (required)
    Remote access server address
  - username: string (required)
    User name
  - userpwhash: string (required)
    Password, encrypted in MD5
  - clientname: string (required)
    Client name
  - appcontext: number (required)
    Application context
  - timeout: number (required)
    Timeout
  - readtimeout: number (required)
    Read timeout
  - parameters: (array of ERPParameterTO)
    Items: ERPParameterTO
    name: string (required)
    Name
    type: (one of 0, 1, 2, 3)
    Indicates what is the type of field value
    
    id Description
    0 Number
    1 String
    2 Boolean
    3 Nested ERPParameterTO value
    value: string (required)
    Value of type depending on provided enum type, may contain number or string or boolean or nested ERPParameterTO object or array of ERPParameterTO objects
Example
```
{
  "rashost": "your remote access server address",
  "username": "your user name",
  "userpwhash": "your password",
  "clientname": "your client name",
  "appcontext": 1,
  "timeout": 120,
  "readtimeout": 60,
  "parameters": [
    {
      "name": "Mandant",
      "value": "1",
      "type": "C"
    }
  ]
}
```

id	Description
N	Number
C	String
L	Boolean
U	Nested ERPParameterTO value

id	Description
0	Number
1	String
2	Boolean
3	Nested ERPParameterTO value

Body
Media type: application/json
Type: object
Properties
- status: number (required)
  Response status code
- data: object (required)
  Response data, in this case with sessionID
Example
```
{
  "retcode": 200,
  "data": "d832f329-42ff-4907-8c3d-0712f13a863f"
}
```

/rest/executedocuframerequest/{sessionId}

/rest/executedocuframerequest/{sessionId}

/rest/executedocuframerequest/{sessionId}

Method that executes DOCUframe request

Request
Response

URI Parameters
- sessionId: string (required)

Body
Media type: application/json
Type: object
Properties:
- requestname: string (required)
  Request name
- readtimeout: number (required)
  Read timeout
- request: string (required)
  Request data in JSON fromat provided as string
Example
```
{
  "requestname": "InterfaceTestMakro",
  "readtimeout": 3000,
  "request": "{ 'myInput' : 'example input' }"
}
```

Body
Media type: application/json
Type: object
Properties
- status: number (required)
  Response status code
- data: object (required)
  Response data in JSON format returned as a string
Example
```
{
  "retcode": 200,
  "data": "{ 'httpStatus': '200', 'result' : 'JSON result from DOCUframe' }"
}
```

/rest/executeerpframerequest/{sessionId}

/rest/executeerpframerequest/{sessionId}

/rest/executeerpframerequest/{sessionId}

Method that executes ERPframe request

Request
Response

URI Parameters
- sessionId: string (required)

Body
Media type: application/json
Possible types:
- ExecuteERPframeRequest
  - idxm: string (required)
    Idxm
  - readtimeout: number (required)
    Read timeout
  - parameters: (array of ERPParameterTO) (required)
    Array of ERPParameterTO parameters
    Items: ERPParameterTO
    name: string (required)
    Name
    type: (one of N, C, L, U)
    Indicates what is the type of field value
    
    id Description
    N Number
    C String
    L Boolean
    U Nested ERPParameterTO value
    value: string (required)
    Value of type depending on provided enum type, may contain number or string or boolean or nested ERPParameterTO object or array of ERPParameterTO objects
- ExecuteERPframeRequest
  - idxm: string (required)
    Idxm
  - readtimeout: number (required)
    Read timeout
  - parameters: (array of ERPParameterTO) (required)
    Array of ERPParameterTO parameters
    Items: ERPParameterTO
    name: string (required)
    Name
    type: (one of 0, 1, 2, 3)
    Indicates what is the type of field value
    
    id Description
    0 Number
    1 String
    2 Boolean
    3 Nested ERPParameterTO value
    value: string (required)
    Value of type depending on provided enum type, may contain number or string or boolean or nested ERPParameterTO object or array of ERPParameterTO objects
Example
```
{
  "idxm": "GETARTIKELDATEN",
  "readtimeout": 60,
  "parameters": [
    {
      "name": "artikelids",
      "type": "C",
      "value": "1713"
    },
    {
      "name": "artikelvkpreise",
      "type": "U",
      "value": [
        {
          "name": "vk1",
          "type": "L",
          "value": true
        },
        {
          "name": "vk2",
          "type": "L",
          "value": true
        }
      ]
    }
  ]
}
```

id	Description
N	Number
C	String
L	Boolean
U	Nested ERPParameterTO value

id	Description
0	Number
1	String
2	Boolean
3	Nested ERPParameterTO value

Body
Media type: application/json
Type: object
Properties
- status: number (required)
  Response status code
- data: object (required)
  Response data in both XML and JSON formats
Example
```
{
  "retcode": 200,
  "data": {
    "content": "response in XML format",
    "object": "response in JSON format"
  }
}
```

/rest/log/{sessionId}

/rest/log/{sessionId}

/rest/log/{sessionId}

Method that logs sent data

Request
Response

URI Parameters
- sessionId: string (required)

Body
Media type: application/json
Type: object
Properties:
- severity: number (required)
  Severity
- time: string (required)
  Time
- origin: string (required)
  Origin
- caller: string (required)
  Caller
- method: string (required)
  Method
- message: string (required)
  Message
- error: string
  Error
Example
```
{
  "severity": 1,
  "time": "2018-01-01 12:00:00",
  "origin": "example origin",
  "caller": "caller",
  "method": "method",
  "message": "message to log",
  "error": "error to log"
}
```

Body
Media type: application/json
Type: object
Properties
- retcode: number (required)
  Response status code
- data: object (required)
  Response data
Example
```
{
  "retcode": 200,
  "data": "OK"
}
```

/rest/close/{sessionId}

/rest/close/{sessionId}

/rest/close/{sessionId}

Method that closes given session

Request
Response

URI Parameters
- sessionId: string (required)

Body
Media type: application/json
Type: object
Properties:
- readtimeout: number (required)
  Read timeout
Example
```
{
  "readtimeout": 2000
}
```

Body
Media type: application/json
Type: object
Properties
- retcode: number (required)
  Response status code
- data: object (required)
  Response data
Example
```
{
  "retcode": 200,
  "data": "OK"
}
```

/_CheckService

/_CheckService

/_CheckSession

/_CheckSession /{sessionId}

/_CheckSession/{sessionId}

Allows to check current session's state.

Request
Response

URI Parameters
- sessionId: string (required)
  Returned by "/rest/opendocuframedb" in response in data field.

Headers
- appkey: string (required)

Body

Media type: application/json

Type: object

Properties

data: object (required)
- username: string (required)
- appNames: (array of string) (required)
- reservedLicenses: (array of string) (required)
- sessionLoad: number (required)
- loginTime: string (required)
  ISO format
- lastActivity: string (required)
  ISO format
- sessionTimeout: string (required)
  ISO format

Example

{
  "status": {
    "internalStatus": "0",
    "statusMessage": "ok"
  },
  "data": {
    "username": "gsdwebservice",
    "appNames": [
      "..."
    ],
    "reservedLicenses": [
      "\\GSD\\Docuframe\\AnyUser"
    ],
    "sessionLoad": 0,
    "loginTime": "2019-07-22T13:56:48.207Z",
    "lastActivity": "2019-07-22T13:57:26.159Z",
    "sessionTimeout": "2019-07-22T14:12:26.159Z"
  }
}

Description
Missing Session ID.

Description
Session ID is invalid.

/_CheckSession/{sessionId}

Allows to check current session's state and also refreshes session's last activity.

Request
Response

URI Parameters
- sessionId: string (required)
  Returned by "/rest/opendocuframedb" in response in data field.

Headers
- appkey: string (required)

Body

Media type: application/json

Type: object

Properties

data: object (required)
- username: string (required)
- appNames: (array of string) (required)
- reservedLicenses: (array of string) (required)
- sessionLoad: number (required)
- loginTime: string (required)
  ISO format
- lastActivity: string (required)
  ISO format
- sessionTimeout: string (required)
  ISO format

Example

{
  "status": {
    "internalStatus": "0",
    "statusMessage": "ok"
  },
  "data": {
    "username": "gsdwebservice",
    "appNames": [
      "..."
    ],
    "reservedLicenses": [
      "\\GSD\\Docuframe\\AnyUser"
    ],
    "sessionLoad": 0,
    "loginTime": "2019-07-22T13:56:48.207Z",
    "lastActivity": "2019-07-22T13:57:26.159Z",
    "sessionTimeout": "2019-07-22T14:12:26.159Z"
  }
}

Description
Missing Session ID.

Description
Session ID is invalid.

/rest/opendocuframedb

Body

Body

/rest/openerpframedb

Body

Body

/rest/executedocuframerequest/{sessionId}

URI Parameters

Body

Body

/rest/executeerpframerequest/{sessionId}

URI Parameters

Body

Body

/rest/log/{sessionId}

URI Parameters

Body

Body

/rest/close/{sessionId}

URI Parameters

Body

Body

/_CheckService

Body

/_CheckSession

URI Parameters

Headers

Body

Description

Description

URI Parameters

Headers

Body

Description

Description