Audio

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAudio

post

Retrieve Audio 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/getAudio

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "Audio": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getAudio"
}

getAudioSelectFields

post

Retrieve Audio 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/getAudioSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "Audio": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getAudioSelectFields"
}

updateAudioByID

post

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

Responses

200

Successful operation.

application/json

post/updateAudioByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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