Skip to content

Operations

getUser

POST

Retrieves information about a user.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/getUser
POST /nexum/627/2022.01/user/getUser HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserSelectFields

POST

Retrieves information about a user with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/getUserSelectFields
POST /nexum/627/2022.01/user/getUserSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SelectableFields": {
    "IncludeAllUserFields": false,
    "UserFields": {
      "Number": true,
      "Name": true,
      "Type": true,
      "ActiveMode": true,
      "LastLogonDate": true,
      "LastLogonTime": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserSelectFieldsFilterChildren

POST

Retrieves information about a user with selected fields and filters children.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/getUserSelectFieldsFilterChildren
POST /nexum/627/2022.01/user/getUserSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SelectableFields": {
    "IncludeAllUserFields": false,
    "UserFields": {
      "Number": true,
      "Name": true,
      "Type": true,
      "ActiveMode": true
    },
    "ActivitySelectableFields": {
      "IncludeAllActivityFields": false,
      "ActivityFields": {
        "UserNumber": true,
        "Date": true,
        "Time": true,
        "Console": true
      }
    },
    "UserTrackingSelectableFields": {
      "IncludeAllUserTrackingFields": false,
      "UserTrackingFields": {
        "Locator": true,
        "Type": true,
        "CreationDate": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "ActivityFilter": {
      "Query": "string"
    },
    "UserTrackingFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getActivityPagedList

POST

Retrieves a paged list of activities.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/getActivityPagedList
POST /nexum/627/2022.01/user/getActivityPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getActivityListSelectFields

POST

Retrieves a list of selected fields for activities.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/getActivityListSelectFields
POST /nexum/627/2022.01/user/getActivityListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SelectableFields": {
    "IncludeAllActivityFields": false,
    "ActivityFields": {
      "UserNumber": true,
      "Date": true,
      "Time": true,
      "Console": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchActivitySelectFields

POST

Searches activities with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/searchActivitySelectFields
POST /nexum/627/2022.01/user/searchActivitySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SearchFilter": {
    "Query": "string"
  },
  "SelectableFields": {
    "IncludeAllActivityFields": false,
    "ActivityFields": {
      "UserNumber": true,
      "Date": true,
      "Time": true,
      "Console": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getActivityPagedListSelectFields

POST

Retrieves a paged list of selected fields for activities.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/getActivityPagedListSelectFields
POST /nexum/627/2022.01/user/getActivityPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllActivityFields": false,
    "ActivityFields": {
      "UserNumber": true,
      "Date": true,
      "Time": true,
      "Branch": true,
      "Console": true,
      "Session": true,
      "HelpCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchActivityPagedSelectFields

POST

Searches activities with pagination and selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
QuerystringrequiredThe filtering query string.
Path Parameters
symstringrequired
Sym number
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/searchActivityPagedSelectFields
POST /nexum/627/2022.01/user/searchActivityPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllActivityFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTracking

POST

Retrieves information about user tracking.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
UserTrackingLocatorintegerrequiredThe locator for user tracking.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/getUserTracking
POST /nexum/627/2022.01/user/getUserTracking HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "UserTrackingLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTrackingSelectFields

POST

Retrieves information about user tracking with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
UserTrackingLocatorintegerrequiredThe locator for user tracking.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/getUserTrackingSelectFields
POST /nexum/627/2022.01/user/getUserTrackingSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "UserTrackingLocator": 0,
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "Locator": true,
      "TrackingCode": true,
      "UserChar1": true,
      "UserCode1": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTrackingPagedList

POST

Retrieves a paged list of user tracking.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/getUserTrackingPagedList
POST /nexum/627/2022.01/user/getUserTrackingPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTrackingListSelectFields

POST

Retrieves a list of selected fields for user tracking.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/getUserTrackingListSelectFields
POST /nexum/627/2022.01/user/getUserTrackingListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "Locator": true,
      "Type": true,
      "CreationDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchUserTrackingSelectFields

POST

Searches user tracking with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/searchUserTrackingSelectFields
POST /nexum/627/2022.01/user/searchUserTrackingSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SearchFilter": {
    "Query": "string"
  },
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "Locator": true,
      "Type": true,
      "CreationDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTrackingPagedListSelectFields

POST

Retrieves a paged list of selected fields for user tracking.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/getUserTrackingPagedListSelectFields
POST /nexum/627/2022.01/user/getUserTrackingPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "Locator": true,
      "Type": true,
      "UserId": true,
      "CreationDate": true,
      "CreationTime": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchUserTrackingPagedSelectFields

POST

Searches user tracking with pagination and selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
QuerystringoptionalThe filtering query string.
Path Parameters
symstringrequired
Sym number
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/searchUserTrackingPagedSelectFields
POST /nexum/627/2022.01/user/searchUserTrackingPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllUserTrackingFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateUserByID

POST

Updates user information based on ID.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/updateUserByID
POST /nexum/627/2022.01/user/updateUserByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "UserUpdatableFields": {
    "Location": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

updateUserTrackingByID

POST

Updates user tracking information based on ID.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserTrackingLocatorintegerrequiredThe locator for user tracking.
UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
POST/nexum/{sym}/2022.01/user/updateUserTrackingByID
POST /nexum/627/2022.01/user/updateUserTrackingByID HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "UserTrackingLocator": 0,
  "UserTrackingUpdatableFields": {
    "UserChar1": "string",
    "UserCode1": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

createUserTracking

POST

Creates a new record for user tracking.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
UserTrackingLocatorintegeroptionalThe locator for user tracking.
POST/nexum/{sym}/2022.01/user/createUserTracking
POST /nexum/627/2022.01/user/createUserTracking HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "UserTrackingCreatableFields": {
    "TrackingCode": 0,
    "UserChar1": "string",
    "UserCode1": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

deleteUserTracking

POST

Deletes a record for user tracking.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

UserNumberintegerrequiredThe user number for the activity.
UserTrackingLocatorintegerrequiredThe locator for user tracking.
Path Parameters
symstringrequired
Sym number
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.
POST/nexum/{sym}/2022.01/user/deleteUserTracking
POST /nexum/627/2022.01/user/deleteUserTracking HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "UserTrackingLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}