DivIndexGlobal

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDivIndexGlobal

post

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

DivIndexGlobalDividendIndexTableintegerRequired

Responses

200

Successful operation.

application/json

post/getDivIndexGlobal

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "DivIndexGlobal": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getDivIndexGlobal"
}

getDivIndexGlobalSelectFields

post

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

DivIndexGlobalDividendIndexTableintegerOptional

Responses

200

Successful operation.

application/json

post/getDivIndexGlobalSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "DivIndexGlobal": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getDivIndexGlobalSelectFields"
}

getDivIndexGlobalPagedList

post

Retrieve DivIndexGlobal 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/getDivIndexGlobalPagedList

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "DivIndexGlobal": [],
  "Token": null,
  "MessageId": "getDivIndexGlobalPagedList"
}

getDivIndexGlobalListSelectFields

post

Retrieve DivIndexGlobal 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/getDivIndexGlobalListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "DivIndexGlobalList": [],
  "MessageId": "getDivIndexGlobalListSelectFields"
}

searchDivIndexGlobalSelectFields

post

Search DivIndexGlobal 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/searchDivIndexGlobalSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "DivIndexGlobalList": [],
  "MessageId": "searchDivIndexGlobalSelectFields"
}

getDivIndexGlobalPagedListSelectFields

post

Retrieve DivIndexGlobal 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/getDivIndexGlobalPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "DivIndexGlobal": [],
  "Token": null,
  "MessageId": "getDivIndexGlobalPagedListSelectFields"
}

searchDivIndexGlobalPagedSelectFields

post

Search DivIndexGlobal 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/searchDivIndexGlobalPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "DivIndexGlobal": [],
  "Token": null,
  "MessageId": "searchDivIndexGlobalPagedSelectFields"
}

updateDivIndexGlobalByID

post

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

DivIndexGlobalDividendIndexTableintegerOptional

Responses

200

Successful operation.

application/json

post/updateDivIndexGlobalByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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