PowerOnService

Run installed PowerOn specfiles using the SYMCONNECT keyword.

Symitar eDocs References: Run PowerOn Specfile, Run PowerOn Specfile and Return Results in Array, SYMCONNECT, SymConnect Specfile Variables

Operations

executePowerOnReturnArray

post

Executes a specfile to PowerOn a connection and returns an array.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/executePowerOnReturnArray

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/poweron/executePowerOnReturnArray HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "Header": {
    "MessageID": "nexumAPIMock"
  },
  "Body": {
    "File": "NX.MOCK.POWERON",
    "RGSession": 1,
    "UserDefinedParameters": {
      "RGUserChr": [
        {
          "ID": 1,
          "Value": "14117"
        },
        {
          "ID": 2,
          "Value": "31415"
        }
      ],
      "RGUserDate": [
        {
          "ID": 1,
          "Value": "2020-01-01"
        }
      ]
    }
  },
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "Header": {
    "MessageID": "nexumAPIMock",
    "RGState": ""
  },
  "Body": {
    "PromptRequest": {
      "RGDataType": "END",
      "RGMaxCodeWidth": "0",
      "RequiredInputDefault": ""
    },
    "RGLine": [
      {
        "-lineNumber": "1",
        "LineValue": "Mock SymXchange PowerOn for 14117."
      },
      {
        "-lineNumber": "2",
        "LineValue": "This is a stateless PowerOn"
      }
    ],
    "RGScreenClear": "false",
    "StatusCode": "0",
    "StatusMessage": "",
    "UserDefinedParameters": {
      "RGUserChr": [
        {
          "ID": "1",
          "Value": "14117"
        },
        {
          "ID": "2",
          "Value": "31415"
        }
      ]
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

executePowerOn

post

Executes a specfile to PowerOn a connection.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/executePowerOn

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/poweron/executePowerOn HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "Header": {
    "MessageID": "nexumAPIMock"
  },
  "Body": {
    "File": "NX.MOCK.POWERON",
    "RGSession": 1,
    "UserDefinedParameters": {
      "RGUserChr": [
        {
          "ID": 1,
          "Value": "14117"
        },
        {
          "ID": 2,
          "Value": "31415"
        }
      ],
      "RGUserDate": [
        {
          "ID": 1,
          "Value": "2020-01-01"
        }
      ]
    }
  },
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "Header": {
    "MessageID": "nexumAPIMock",
    "RGState": ""
  },
  "Body": {
    "PromptRequest": {
      "RGDataType": "END",
      "RGMaxCodeWidth": "0",
      "RequiredInputDefault": ""
    },
    "RGLine": [
      {
        "-lineNumber": "1",
        "LineValue": "Mock SymXchange PowerOn for 14117."
      },
      {
        "-lineNumber": "2",
        "LineValue": "This is a stateless PowerOn"
      }
    ],
    "RGScreenClear": "false",
    "StatusCode": "0",
    "StatusMessage": "",
    "UserDefinedParameters": {
      "RGUserChr": [
        {
          "ID": "1",
          "Value": "14117"
        },
        {
          "ID": "2",
          "Value": "31415"
        }
      ]
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}