SymXGeneral

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSymXGeneral

post

Retrieve getSymXGeneral data.

Authorizations
Body
SymXGeneralInstanceIdintegerRequired
Responses
200

Successful operation.

application/json
post
/getSymXGeneral
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: 150

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SymXGeneralInstanceId": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXGeneral": {
    "CustomSpecfile": [
      {
        "EntryId": 1,
        "CustomSpecfile": "text"
      }
    ],
    "FicsAppPassword": "text",
    "FicsAppUserId": "text",
    "FicsDataSourceName": "text",
    "FicsDbPassword": "text",
    "FicsDbUserId": "text",
    "NoticesPrinterType": 1,
    "SpecfileLoadMethod": [
      {
        "EntryId": 1,
        "SpecfileLoadMethod": 1
      }
    ],
    "InstanceId": 1
  }
}

getSymXGeneralSelectFields

post

Retrieve getSymXGeneralSelectFields data.

Authorizations
Body
SymXGeneralInstanceIdintegerOptional
Responses
200

Successful operation.

application/json
post
/getSymXGeneralSelectFields
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: 430

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SymXGeneralInstanceId": 1,
  "SelectableFields": {
    "IncludeAllSymXGeneralFields": true,
    "SymXGeneralFields": {
      "CustomSpecfile": [
        1
      ],
      "FicsAppPassword": true,
      "FicsAppUserId": true,
      "FicsDataSourceName": true,
      "FicsDbPassword": true,
      "FicsDbUserId": true,
      "InstanceId": true,
      "NoticesPrinterType": true,
      "SpecfileLoadMethod": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXGeneral": {
    "CustomSpecfile": [
      {
        "EntryId": 1,
        "CustomSpecfile": "text"
      }
    ],
    "FicsAppPassword": "text",
    "FicsAppUserId": "text",
    "FicsDataSourceName": "text",
    "FicsDbPassword": "text",
    "FicsDbUserId": "text",
    "NoticesPrinterType": 1,
    "SpecfileLoadMethod": [
      {
        "EntryId": 1,
        "SpecfileLoadMethod": 1
      }
    ],
    "InstanceId": 1
  }
}

getSymXGeneralPagedList

post

Retrieve getSymXGeneralPagedList data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getSymXGeneralPagedList
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: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXGeneral": [
    {
      "CustomSpecfile": [
        {
          "EntryId": 1,
          "CustomSpecfile": "text"
        }
      ],
      "FicsAppPassword": "text",
      "FicsAppUserId": "text",
      "FicsDataSourceName": "text",
      "FicsDbPassword": "text",
      "FicsDbUserId": "text",
      "NoticesPrinterType": 1,
      "SpecfileLoadMethod": [
        {
          "EntryId": 1,
          "SpecfileLoadMethod": 1
        }
      ],
      "InstanceId": 1
    }
  ],
  "Token": "text"
}

getSymXGeneralListSelectFields

post

Retrieve getSymXGeneralListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getSymXGeneralListSelectFields
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: 404

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXGeneralFields": true,
    "SymXGeneralFields": {
      "CustomSpecfile": [
        1
      ],
      "FicsAppPassword": true,
      "FicsAppUserId": true,
      "FicsDataSourceName": true,
      "FicsDbPassword": true,
      "FicsDbUserId": true,
      "InstanceId": true,
      "NoticesPrinterType": true,
      "SpecfileLoadMethod": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXGeneralList": {
    "hasReachedMaximumListSize": true,
    "SymXGeneral": [
      {
        "CustomSpecfile": [
          {
            "EntryId": 1,
            "CustomSpecfile": "text"
          }
        ],
        "FicsAppPassword": "text",
        "FicsAppUserId": "text",
        "FicsDataSourceName": "text",
        "FicsDbPassword": "text",
        "FicsDbUserId": "text",
        "NoticesPrinterType": 1,
        "SpecfileLoadMethod": [
          {
            "EntryId": 1,
            "SpecfileLoadMethod": 1
          }
        ],
        "InstanceId": 1
      }
    ]
  }
}

searchSymXGeneralSelectFields

post

Retrieve a list of select fields for SymX general settings

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchSymXGeneralSelectFields
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: 436

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXGeneralFields": true,
    "SymXGeneralFields": {
      "CustomSpecfile": [
        1
      ],
      "FicsAppPassword": true,
      "FicsAppUserId": true,
      "FicsDataSourceName": true,
      "FicsDbPassword": true,
      "FicsDbUserId": true,
      "InstanceId": true,
      "NoticesPrinterType": true,
      "SpecfileLoadMethod": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXGeneralList": {
    "hasReachedMaximumListSize": true,
    "SymXGeneral": [
      {
        "CustomSpecfile": [
          {
            "EntryId": 1,
            "CustomSpecfile": "text"
          }
        ],
        "FicsAppPassword": "text",
        "FicsAppUserId": "text",
        "FicsDataSourceName": "text",
        "FicsDbPassword": "text",
        "FicsDbUserId": "text",
        "NoticesPrinterType": 1,
        "SpecfileLoadMethod": [
          {
            "EntryId": 1,
            "SpecfileLoadMethod": 1
          }
        ],
        "InstanceId": 1
      }
    ]
  }
}

getSymXGeneralPagedListSelectFields

post

Retrieve getSymXGeneralPagedListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getSymXGeneralPagedListSelectFields
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: 498

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSymXGeneralFields": true,
    "SymXGeneralFields": {
      "CustomSpecfile": [
        1
      ],
      "FicsAppPassword": true,
      "FicsAppUserId": true,
      "FicsDataSourceName": true,
      "FicsDbPassword": true,
      "FicsDbUserId": true,
      "InstanceId": true,
      "NoticesPrinterType": true,
      "SpecfileLoadMethod": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXGeneral": [
    {
      "CustomSpecfile": [
        {
          "EntryId": 1,
          "CustomSpecfile": "text"
        }
      ],
      "FicsAppPassword": "text",
      "FicsAppUserId": "text",
      "FicsDataSourceName": "text",
      "FicsDbPassword": "text",
      "FicsDbUserId": "text",
      "NoticesPrinterType": 1,
      "SpecfileLoadMethod": [
        {
          "EntryId": 1,
          "SpecfileLoadMethod": 1
        }
      ],
      "InstanceId": 1
    }
  ],
  "Token": "text"
}

searchSymXGeneralPagedSelectFields

post

Retrieve a paged list of select fields for SymX general settings

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchSymXGeneralPagedSelectFields
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: 513

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSymXGeneralFields": true,
    "SymXGeneralFields": {
      "CustomSpecfile": [
        1
      ],
      "FicsAppPassword": true,
      "FicsAppUserId": true,
      "FicsDataSourceName": true,
      "FicsDbPassword": true,
      "FicsDbUserId": true,
      "InstanceId": true,
      "NoticesPrinterType": true,
      "SpecfileLoadMethod": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXGeneral": [
    {
      "CustomSpecfile": [
        {
          "EntryId": 1,
          "CustomSpecfile": "text"
        }
      ],
      "FicsAppPassword": "text",
      "FicsAppUserId": "text",
      "FicsDataSourceName": "text",
      "FicsDbPassword": "text",
      "FicsDbUserId": "text",
      "NoticesPrinterType": 1,
      "SpecfileLoadMethod": [
        {
          "EntryId": 1,
          "SpecfileLoadMethod": 1
        }
      ],
      "InstanceId": 1
    }
  ],
  "Token": "text"
}

updateSymXGeneralByID

post

Update SymX general by ID

Authorizations
Body
SymXGeneralInstanceIdintegerOptional
Responses
200

Successful operation.

application/json
post
/updateSymXGeneralByID
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: 443

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SymXGeneralInstanceId": 1,
  "SymXGeneralUpdatableFields": {
    "CustomSpecfile": [
      {
        "EntryId": 1,
        "CustomSpecfile": "text"
      }
    ],
    "FicsAppPassword": "text",
    "FicsAppUserId": "text",
    "FicsDataSourceName": "text",
    "FicsDbPassword": "text",
    "FicsDbUserId": "text",
    "NoticesPrinterType": 1,
    "SpecfileLoadMethod": [
      {
        "EntryId": 1,
        "SpecfileLoadMethod": 1
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}
PreviousSymXDeviceMapNextSymXInstance

Last updated

Was this helpful?