ScreenDefinition

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getScreenDefinition

post

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

ScreenDefinitionScreenSelectionintegerOptional

ScreenDefinitionTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getScreenDefinition

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ScreenDefinition": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getScreenDefinition"
}

getScreenDefinitionSelectFields

post

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

ScreenDefinitionScreenSelectionintegerOptional

ScreenDefinitionTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getScreenDefinitionSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ScreenDefinition": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getScreenDefinitionSelectFields"
}

getScreenDefinitionPagedList

post

Retrieve ScreenDefinition 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/getScreenDefinitionPagedList

HTTPcURLJavaScriptPython

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

{
  "ScreenDefinition": [],
  "Token": null,
  "MessageId": "getScreenDefinitionPagedList"
}

getScreenDefinitionListSelectFields

post

Retrieve ScreenDefinition 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/getScreenDefinitionListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ScreenDefinitionList": [],
  "MessageId": "getScreenDefinitionListSelectFields"
}

searchScreenDefinitionSelectFields

post

Search ScreenDefinition 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/searchScreenDefinitionSelectFields

HTTPcURLJavaScriptPython

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

200

Successful operation.

{
  "ScreenDefinitionList": [],
  "MessageId": "searchScreenDefinitionSelectFields"
}

getScreenDefinitionPagedListSelectFields

post

Retrieve ScreenDefinition 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/getScreenDefinitionPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ScreenDefinition": [],
  "Token": null,
  "MessageId": "getScreenDefinitionPagedListSelectFields"
}

searchScreenDefinitionPagedSelectFields

post

Search ScreenDefinition 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/searchScreenDefinitionPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "ScreenDefinition": [],
  "Token": null,
  "MessageId": "searchScreenDefinitionPagedSelectFields"
}

updateScreenDefinitionByID

post

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

ScreenDefinitionScreenSelectionintegerOptional

ScreenDefinitionTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateScreenDefinitionByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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