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/persistent/poweron/executePowerOnReturnArray HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "Header": {
    "MessageID": "nexumAPIMock"
  },
  "Body": {
    "File": "NX.MOCK.POWERON",
    "RGSession": 1,
    "UserDefinedParameters": {
      "RGUserChr": [
        {
          "ID": 1,
          "Value": "14117"
        },
        {
          "ID": 2,
          "Value": "31415"
        }
      ],
      "RGUserNum": [
        {
          "ID": 1,
          "Value": 20200101
        }
      ]
    }
  },
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": {
        "symx-user-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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

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/persistent/poweron/executePowerOn HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "Header": {
    "MessageID": "nexumAPIMock"
  },
  "Body": {
    "File": "NX.MOCK.POWERON",
    "RGSession": 1,
    "UserDefinedParameters": {
      "RGUserChr": [
        {
          "ID": 1,
          "Value": "14117"
        },
        {
          "ID": 2,
          "Value": "31415"
        }
      ],
      "RGUserNum": [
        {
          "ID": 1,
          "Value": 20200101
        }
      ]
    }
  },
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": {
        "symx-user-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Header": {
    "MessageID": "nexumAPIMock",
    "RGState": null
  },
  "Body": {
    "PromptRequest": {
      "RGDataType": "END",
      "RGMaxCodeWidth": 0,
      "RequiredInputDefault": null,
      "RGPrompt": null
    },
    "RGLines": "Mock SymXchange PowerOn for 14117.\nThis is a stateless PowerOn\n",
    "RGScreenClear": false,
    "StatusCode": 0,
    "StatusMessage": null,
    "UserDefinedParameters": {
      "RGUserChr": [
        {
          "ID": 1,
          "Value": "14117"
        },
        {
          "ID": 2,
          "Value": "31415"
        }
      ],
      "RGUserNum": [
        {
          "ID": 1,
          "Value": 20200101
        }
      ]
    }
  }
}