SecField

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSecField

post

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

SecFieldRecordSelectionintegerRequired

Responses

200

Successful operation.

application/json

post/getSecField

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "SecField": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSecField"
}

getSecFieldSelectFields

post

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

SecFieldRecordSelectionintegerOptional

Responses

200

Successful operation.

application/json

post/getSecFieldSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecFieldSelectFields 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": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SecFieldRecordSelection": 0,
  "SelectableFields": {
    "SecFieldFields": {
      "RecordSelection": true
    }
  }
}

200

Successful operation.

{
  "SecField": {
    "RecordSelection": 0
  },
  "MessageId": "getSecFieldSelectFields"
}

getSecFieldPagedList

post

Retrieve SecField 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/getSecFieldPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecFieldPagedList 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.

{
  "SecField": [],
  "Token": null,
  "MessageId": "getSecFieldPagedList"
}

getSecFieldListSelectFields

post

Retrieve SecField 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/getSecFieldListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecFieldListSelectFields 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": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllSecFieldFields": true
  }
}

200

Successful operation.

{
  "SecFieldList": [],
  "MessageId": "getSecFieldListSelectFields"
}

searchSecFieldSelectFields

post

Search SecField 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/searchSecFieldSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchSecFieldSelectFields 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": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllSecFieldFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SecFieldList": [],
  "MessageId": "searchSecFieldSelectFields"
}

getSecFieldPagedListSelectFields

post

Retrieve SecField 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/getSecFieldPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "SecField": [
    {
      "RecordSelection": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getSecFieldPagedListSelectFields"
}

searchSecFieldPagedSelectFields

post

Search SecField 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/searchSecFieldPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "SecField": [
    {
      "RecordSelection": 0
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchSecFieldPagedSelectFields"
}

updateSecFieldByID

post

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

SecFieldRecordSelectionintegerOptional

Responses

200

Successful operation.

application/json

post/updateSecFieldByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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