InqDefinition

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInqDefinition

post

Get the getInqDefinition data.

Authorizations
Body
InqDefinitionInquiryNumberintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "InqDefinition": {
    "CardNameRecord": [
      {
        "EntryId": 1,
        "CardNameRecord": 1
      }
    ],
    "InqField": [
      {
        "EntryId": 1,
        "InqField": 1
      }
    ],
    "InquiryName": "text",
    "Selection": 1,
    "SubField": [
      {
        "EntryId": 1,
        "SubField": 1
      }
    ],
    "InquiryNumber": 1
  }
}

getInqDefinitionSelectFields

post

Get the getInqDefinitionSelectFields data.

Authorizations
Body
InqDefinitionInquiryNumberintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InqDefinitionInquiryNumber": 1,
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        1
      ],
      "InqField": [
        1
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InqDefinition": {
    "CardNameRecord": [
      {
        "EntryId": 1,
        "CardNameRecord": 1
      }
    ],
    "InqField": [
      {
        "EntryId": 1,
        "InqField": 1
      }
    ],
    "InquiryName": "text",
    "Selection": 1,
    "SubField": [
      {
        "EntryId": 1,
        "SubField": 1
      }
    ],
    "InquiryNumber": 1
  }
}

getInqDefinitionPagedList

post

Get the getInqDefinitionPagedList data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getInqDefinitionPagedList
POST /nexum/627/2022.01/parameter/getInqDefinitionPagedList 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.

{
  "InqDefinition": [
    {
      "CardNameRecord": [
        {
          "EntryId": 1,
          "CardNameRecord": 1
        }
      ],
      "InqField": [
        {
          "EntryId": 1,
          "InqField": 1
        }
      ],
      "InquiryName": "text",
      "Selection": 1,
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 1
        }
      ],
      "InquiryNumber": 1
    }
  ],
  "Token": "text"
}

getInqDefinitionListSelectFields

post

Get the getInqDefinitionListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        1
      ],
      "InqField": [
        1
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InqDefinitionList": {
    "hasReachedMaximumListSize": true,
    "InqDefinition": [
      {
        "CardNameRecord": [
          {
            "EntryId": 1,
            "CardNameRecord": 1
          }
        ],
        "InqField": [
          {
            "EntryId": 1,
            "InqField": 1
          }
        ],
        "InquiryName": "text",
        "Selection": 1,
        "SubField": [
          {
            "EntryId": 1,
            "SubField": 1
          }
        ],
        "InquiryNumber": 1
      }
    ]
  }
}

searchInqDefinitionSelectFields

post

Field for selecting various options related to searchinqdefinitionselectfields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        1
      ],
      "InqField": [
        1
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InqDefinitionList": {
    "hasReachedMaximumListSize": true,
    "InqDefinition": [
      {
        "CardNameRecord": [
          {
            "EntryId": 1,
            "CardNameRecord": 1
          }
        ],
        "InqField": [
          {
            "EntryId": 1,
            "InqField": 1
          }
        ],
        "InquiryName": "text",
        "Selection": 1,
        "SubField": [
          {
            "EntryId": 1,
            "SubField": 1
          }
        ],
        "InquiryNumber": 1
      }
    ]
  }
}

getInqDefinitionPagedListSelectFields

post

Get the getInqDefinitionPagedListSelectFields data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        1
      ],
      "InqField": [
        1
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InqDefinition": [
    {
      "CardNameRecord": [
        {
          "EntryId": 1,
          "CardNameRecord": 1
        }
      ],
      "InqField": [
        {
          "EntryId": 1,
          "InqField": 1
        }
      ],
      "InquiryName": "text",
      "Selection": 1,
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 1
        }
      ],
      "InquiryNumber": 1
    }
  ],
  "Token": "text"
}

searchInqDefinitionPagedSelectFields

post

Field for selecting various options related to searchinqdefinitionpagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllInqDefinitionFields": true,
    "InqDefinitionFields": {
      "CardNameRecord": [
        1
      ],
      "InqField": [
        1
      ],
      "InquiryName": true,
      "InquiryNumber": true,
      "Selection": true,
      "SubField": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "InqDefinition": [
    {
      "CardNameRecord": [
        {
          "EntryId": 1,
          "CardNameRecord": 1
        }
      ],
      "InqField": [
        {
          "EntryId": 1,
          "InqField": 1
        }
      ],
      "InquiryName": "text",
      "Selection": 1,
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 1
        }
      ],
      "InquiryNumber": 1
    }
  ],
  "Token": "text"
}

updateInqDefinitionByID

post
Authorizations
Body
InqDefinitionInquiryNumberintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "InqDefinitionInquiryNumber": 1,
  "InqDefinitionUpdatableFields": {
    "CardNameRecord": [
      {
        "EntryId": 1,
        "CardNameRecord": 1
      }
    ],
    "InqField": [
      {
        "EntryId": 1,
        "InqField": 1
      }
    ],
    "InquiryName": "text",
    "Selection": 1,
    "SubField": [
      {
        "EntryId": 1,
        "SubField": 1
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?