SymXGeneral

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSymXGeneral

post

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

SymXGeneralInstanceIdintegerRequired

Responses

200

Successful operation.

application/json

post/getSymXGeneral

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "SymXGeneral": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXGeneral"
}

getSymXGeneralSelectFields

post

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

SymXGeneralInstanceIdintegerOptional

Responses

200

Successful operation.

application/json

post/getSymXGeneralSelectFields

HTTPcURLJavaScriptPython

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

200

Successful operation.

{
  "SymXGeneral": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getSymXGeneralSelectFields"
}

getSymXGeneralPagedList

post

Retrieve SymXGeneral 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/getSymXGeneralPagedList

HTTPcURLJavaScriptPython

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

{
  "SymXGeneral": [],
  "Token": null,
  "MessageId": "getSymXGeneralPagedList"
}

getSymXGeneralListSelectFields

post

Retrieve SymXGeneral 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/getSymXGeneralListSelectFields

HTTPcURLJavaScriptPython

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

200

Successful operation.

{
  "SymXGeneralList": [],
  "MessageId": "getSymXGeneralListSelectFields"
}

searchSymXGeneralSelectFields

post

Search SymXGeneral 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/searchSymXGeneralSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllSymXGeneralFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SymXGeneralList": [],
  "MessageId": "searchSymXGeneralSelectFields"
}

getSymXGeneralPagedListSelectFields

post

Retrieve SymXGeneral 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/getSymXGeneralPagedListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "SymXGeneral": [
    {
      "CustomSpecfile": [
        {
          "EntryId": 1,
          "CustomSpecfile": "NX.MOCK.POWERON"
        }
      ],
      "FicsAppPassword": null,
      "FicsAppUserId": null,
      "InstanceId": 0,
      "NoticesPrinterType": 0,
      "SpecfileLoadMethod": [
        {
          "EntryId": 1,
          "SpecfileLoadMethod": 0
        }
      ]
    }
  ],
  "Token": null,
  "MessageId": "getSymXGeneralPagedListSelectFields"
}

searchSymXGeneralPagedSelectFields

post

Search SymXGeneral 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/searchSymXGeneralPagedSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "SymXGeneral": [
    {
      "CustomSpecfile": [
        {
          "EntryId": 1,
          "CustomSpecfile": "NX.MOCK.POWERON"
        }
      ],
      "FicsAppPassword": null,
      "FicsAppUserId": null,
      "InstanceId": 0,
      "NoticesPrinterType": 0,
      "SpecfileLoadMethod": [
        {
          "EntryId": 1,
          "SpecfileLoadMethod": 0
        }
      ]
    }
  ],
  "Token": null,
  "MessageId": "searchSymXGeneralPagedSelectFields"
}

updateSymXGeneralByID

post

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

SymXGeneralInstanceIdintegerOptional

Responses

200

Successful operation.

application/json

post/updateSymXGeneralByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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