UserFm

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getUserFm

post

Retrieve UserFm 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/getUserFm

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserFm": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getUserFm"
}

getUserFmSelectFields

post

Retrieve UserFm 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/getUserFmSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "UserFm": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getUserFmSelectFields"
}