ParticipantFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getParticipantFieldName

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ParticipantFieldNameFieldintegerRequired

Responses

200

Successful operation.

application/json

post/getParticipantFieldName

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantFieldNameField": "example-value",
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ParticipantFieldName": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getParticipantFieldName"
}

getParticipantFieldNameSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ParticipantFieldNameFieldintegerOptional

Responses

200

Successful operation.

application/json

post/getParticipantFieldNameSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "ParticipantFieldNameField": 1,
  "SelectableFields": {
    "ParticipantFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "ParticipantFieldName": {
    "Field": 1,
    "FieldName": "User Char   01"
  },
  "MessageId": "getParticipantFieldNameSelectFields"
}

getParticipantFieldNamePagedList

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getParticipantFieldNamePagedList

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

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

200

Successful operation.

{
  "ParticipantFieldName": [],
  "Token": null,
  "MessageId": "getParticipantFieldNamePagedList"
}

getParticipantFieldNameListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getParticipantFieldNameListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllParticipantFieldNameFields": true
  }
}

200

Successful operation.

{
  "ParticipantFieldNameList": [],
  "MessageId": "getParticipantFieldNameListSelectFields"
}

searchParticipantFieldNameSelectFields

post

Search ParticipantFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchParticipantFieldNameSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllParticipantFieldNameFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ParticipantFieldNameList": [],
  "MessageId": "searchParticipantFieldNameSelectFields"
}

getParticipantFieldNamePagedListSelectFields

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getParticipantFieldNamePagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "ParticipantFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "ParticipantFieldName": [
    {
      "Field": 1,
      "FieldName": "User Char   01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getParticipantFieldNamePagedListSelectFields"
}

searchParticipantFieldNamePagedSelectFields

post

Search ParticipantFieldName parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchParticipantFieldNamePagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "ParticipantFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  }
}

200

Successful operation.

{
  "ParticipantFieldName": [
    {
      "Field": 1,
      "FieldName": "User Char   01"
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchParticipantFieldNamePagedSelectFields"
}

updateParticipantFieldNameByID

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ParticipantFieldNameFieldintegerOptional

Responses

200

Successful operation.

application/json

post/updateParticipantFieldNameByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ParticipantFieldNameField": "example-value",
  "ParticipantFieldNameUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

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