AnalysisFloat

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAnalysisFloat

post

Retrieve AnalysisFloat 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

AnalysisFloatBranchintegerRequired

Responses

200

Successful operation.

application/json

post/getAnalysisFloat

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "AnalysisFloat": {
    "Branch": 1,
    "BranchReference": 0,
    "BranchValidCode": 1,
    "ForeignItemFloatDays": 30,
    "LocalFloatDays": 2,
    "NonlocalFloatDays": 5
  },
  "MessageId": "getAnalysisFloat"
}

getAnalysisFloatSelectFields

post

Retrieve AnalysisFloat 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

AnalysisFloatBranchintegerOptional

Responses

200

Successful operation.

application/json

post/getAnalysisFloatSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "AnalysisFloatBranch": 0,
  "SelectableFields": {
    "IncludeAllAnalysisFloatFields": true
  }
}

200

Successful operation.

{
  "AnalysisFloat": {
    "Branch": 0,
    "BranchReference": 0,
    "BranchValidCode": 0,
    "ForeignItemFloatDays": 30,
    "LocalFloatDays": 2,
    "NonlocalFloatDays": 5,
    "RoutingNumberFloatDays": [
      {
        "EntryId": 1,
        "RoutingNumberFloatDays": 0
      }
    ]
  },
  "MessageId": "getAnalysisFloatSelectFields"
}

getAnalysisFloatPagedList

post

Retrieve AnalysisFloat 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

TokenstringOptional

post/getAnalysisFloatPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "AnalysisFloat": [],
  "Token": null,
  "MessageId": "getAnalysisFloatPagedList"
}

getAnalysisFloatListSelectFields

post

Retrieve AnalysisFloat 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/getAnalysisFloatListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllAnalysisFloatFields": true
  }
}

200

Successful operation.

{
  "AnalysisFloatList": [],
  "MessageId": "getAnalysisFloatListSelectFields"
}

searchAnalysisFloatSelectFields

post

Search AnalysisFloat 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/searchAnalysisFloatSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "SelectableFields": {
    "IncludeAllAnalysisFloatFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "AnalysisFloatList": [],
  "MessageId": "searchAnalysisFloatSelectFields"
}

getAnalysisFloatPagedListSelectFields

post

Retrieve AnalysisFloat 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

TokenstringOptional

post/getAnalysisFloatPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllAnalysisFloatFields": true
  }
}

200

Successful operation.

{
  "AnalysisFloat": [
    {
      "Branch": 0,
      "BranchReference": 0,
      "BranchValidCode": 0,
      "ForeignItemFloatDays": 30,
      "LocalFloatDays": 2,
      "NonlocalFloatDays": 5,
      "RoutingNumberFloatDays": [
        {
          "EntryId": 1,
          "RoutingNumberFloatDays": 0
        }
      ]
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getAnalysisFloatPagedListSelectFields"
}

searchAnalysisFloatPagedSelectFields

post

Search AnalysisFloat 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

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchAnalysisFloatPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "{symx-administrative-password}"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllAnalysisFloatFields": true
  }
}

200

Successful operation.

{
  "AnalysisFloat": [
    {
      "Branch": 0,
      "BranchReference": 0,
      "BranchValidCode": 0,
      "ForeignItemFloatDays": 30,
      "LocalFloatDays": 2,
      "NonlocalFloatDays": 5,
      "RoutingNumberFloatDays": [
        {
          "EntryId": 1,
          "RoutingNumberFloatDays": 0
        }
      ]
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchAnalysisFloatPagedSelectFields"
}

updateAnalysisFloatByID

post

Update AnalysisFloat 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

AnalysisFloatBranchintegerOptional

Responses

200

Successful operation.

application/json

post/updateAnalysisFloatByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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