AnalysisGlobal

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAnalysisGlobal

post

Retrieve AnalysisGlobal parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getAnalysisGlobal

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "AnalysisGlobal": {
    "AnalyzedSharePromptSetting": 0,
    "Counter": [
      {
        "EntryId": 1,
        "Counter": "Deposit"
      }
    ],
    "ReserveCalculationType": 1,
    "ReserveRate": "0.000",
    "UsePromptSettings": false
  },
  "MessageId": "getAnalysisGlobal"
}

getAnalysisGlobalSelectFields

post

Retrieve AnalysisGlobal parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getAnalysisGlobalSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "AnalysisGlobalFields": {
      "ReserveRate": true,
      "UsePromptSettings": true,
      "Counter": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "AnalysisGlobal": {
    "Counter": [
      {
        "EntryId": 1,
        "Counter": "Deposit"
      }
    ],
    "ReserveRate": "0.000",
    "UsePromptSettings": false
  },
  "MessageId": "getAnalysisGlobalSelectFields"
}

updateAnalysisGlobalByID

post

Update AnalysisGlobal parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/updateAnalysisGlobalByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "AnalysisGlobalUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateAnalysisGlobalByID"
}