BatchRc

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getBatchRc

post
Authorizations
Body
BatchRcBatchReturnCodeintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "BatchRc": {
    "BatchReturnCodeDefinedType": 1,
    "BatchReturnCodeDescription": "text",
    "BatchReturnCode": 1
  }
}

getBatchRcSelectFields

post
Authorizations
Body
BatchRcBatchReturnCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "BatchRcBatchReturnCode": 1,
  "SelectableFields": {
    "IncludeAllBatchRcFields": true,
    "BatchRcFields": {
      "BatchReturnCode": true,
      "BatchReturnCodeDefinedType": true,
      "BatchReturnCodeDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchRc": {
    "BatchReturnCodeDefinedType": 1,
    "BatchReturnCodeDescription": "text",
    "BatchReturnCode": 1
  }
}

getBatchRcPagedList

post
Authorizations
Body
Responses
200

Successful operation.

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

{
  "BatchRc": [
    {
      "BatchReturnCodeDefinedType": 1,
      "BatchReturnCodeDescription": "text",
      "BatchReturnCode": 1
    }
  ],
  "Token": "text"
}

getBatchRcListSelectFields

post
Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllBatchRcFields": true,
    "BatchRcFields": {
      "BatchReturnCode": true,
      "BatchReturnCodeDefinedType": true,
      "BatchReturnCodeDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchRcList": {
    "hasReachedMaximumListSize": true,
    "BatchRc": [
      {
        "BatchReturnCodeDefinedType": 1,
        "BatchReturnCodeDescription": "text",
        "BatchReturnCode": 1
      }
    ]
  }
}

searchBatchRcSelectFields

post

Search batch record select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllBatchRcFields": true,
    "BatchRcFields": {
      "BatchReturnCode": true,
      "BatchReturnCodeDefinedType": true,
      "BatchReturnCodeDescription": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchRcList": {
    "hasReachedMaximumListSize": true,
    "BatchRc": [
      {
        "BatchReturnCodeDefinedType": 1,
        "BatchReturnCodeDescription": "text",
        "BatchReturnCode": 1
      }
    ]
  }
}

getBatchRcPagedListSelectFields

post
Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllBatchRcFields": true,
    "BatchRcFields": {
      "BatchReturnCode": true,
      "BatchReturnCodeDefinedType": true,
      "BatchReturnCodeDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchRc": [
    {
      "BatchReturnCodeDefinedType": 1,
      "BatchReturnCodeDescription": "text",
      "BatchReturnCode": 1
    }
  ],
  "Token": "text"
}

searchBatchRcPagedSelectFields

post

Search batch record paged select fields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllBatchRcFields": true,
    "BatchRcFields": {
      "BatchReturnCode": true,
      "BatchReturnCodeDefinedType": true,
      "BatchReturnCodeDescription": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "BatchRc": [
    {
      "BatchReturnCodeDefinedType": 1,
      "BatchReturnCodeDescription": "text",
      "BatchReturnCode": 1
    }
  ],
  "Token": "text"
}

updateBatchRcByID

post

Update Batch RC by ID

Authorizations
Body
BatchRcBatchReturnCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "BatchRcBatchReturnCode": 1,
  "BatchRcUpdatableFields": {
    "BatchReturnCodeDefinedType": 1,
    "BatchReturnCodeDescription": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?