SymXInstance

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSymXInstance

post

Retrieve getSymXInstance data.

Authorizations
Body
SymXInstanceInstanceIdintegerRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getSymXInstance HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 151

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

Successful operation.

{
  "SymXInstance": {
    "InstanceId": 1,
    "CrudLoggingThreshold": 1,
    "Description": "text",
    "InternalListSize": 1,
    "InternalProviderKeyStore": "text",
    "Name": "text",
    "OtherLoggingThreshold": 1,
    "PowerOnLoggingThreshold": 1,
    "TokenValidity": 1,
    "TransactionsLoggingThreshold": 1
  }
}

getSymXInstanceSelectFields

post

Retrieve getSymXInstanceSelectFields data.

Authorizations
Body
SymXInstanceInstanceIdintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getSymXInstanceSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 481

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SymXInstanceInstanceId": 1,
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true,
    "SymXInstanceFields": {
      "CrudLoggingThreshold": true,
      "Description": true,
      "InstanceId": true,
      "InternalListSize": true,
      "InternalProviderKeyStore": true,
      "Name": true,
      "OtherLoggingThreshold": true,
      "PowerOnLoggingThreshold": true,
      "TokenValidity": true,
      "TransactionsLoggingThreshold": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXInstance": {
    "InstanceId": 1,
    "CrudLoggingThreshold": 1,
    "Description": "text",
    "InternalListSize": 1,
    "InternalProviderKeyStore": "text",
    "Name": "text",
    "OtherLoggingThreshold": 1,
    "PowerOnLoggingThreshold": 1,
    "TokenValidity": 1,
    "TransactionsLoggingThreshold": 1
  }
}

getSymXInstancePagedList

post

Retrieve getSymXInstancePagedList data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getSymXInstancePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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.

{
  "SymXInstance": [
    {
      "InstanceId": 1,
      "CrudLoggingThreshold": 1,
      "Description": "text",
      "InternalListSize": 1,
      "InternalProviderKeyStore": "text",
      "Name": "text",
      "OtherLoggingThreshold": 1,
      "PowerOnLoggingThreshold": 1,
      "TokenValidity": 1,
      "TransactionsLoggingThreshold": 1
    }
  ],
  "Token": "text"
}

getSymXInstanceListSelectFields

post

Retrieve getSymXInstanceListSelectFields data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getSymXInstanceListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 454

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true,
    "SymXInstanceFields": {
      "CrudLoggingThreshold": true,
      "Description": true,
      "InstanceId": true,
      "InternalListSize": true,
      "InternalProviderKeyStore": true,
      "Name": true,
      "OtherLoggingThreshold": true,
      "PowerOnLoggingThreshold": true,
      "TokenValidity": true,
      "TransactionsLoggingThreshold": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXInstanceList": {
    "hasReachedMaximumListSize": true,
    "SymXInstance": [
      {
        "InstanceId": 1,
        "CrudLoggingThreshold": 1,
        "Description": "text",
        "InternalListSize": 1,
        "InternalProviderKeyStore": "text",
        "Name": "text",
        "OtherLoggingThreshold": 1,
        "PowerOnLoggingThreshold": 1,
        "TokenValidity": 1,
        "TransactionsLoggingThreshold": 1
      }
    ]
  }
}

searchSymXInstanceSelectFields

post

Retrieve a list of select fields for SymX instances

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchSymXInstanceSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 486

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true,
    "SymXInstanceFields": {
      "CrudLoggingThreshold": true,
      "Description": true,
      "InstanceId": true,
      "InternalListSize": true,
      "InternalProviderKeyStore": true,
      "Name": true,
      "OtherLoggingThreshold": true,
      "PowerOnLoggingThreshold": true,
      "TokenValidity": true,
      "TransactionsLoggingThreshold": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXInstanceList": {
    "hasReachedMaximumListSize": true,
    "SymXInstance": [
      {
        "InstanceId": 1,
        "CrudLoggingThreshold": 1,
        "Description": "text",
        "InternalListSize": 1,
        "InternalProviderKeyStore": "text",
        "Name": "text",
        "OtherLoggingThreshold": 1,
        "PowerOnLoggingThreshold": 1,
        "TokenValidity": 1,
        "TransactionsLoggingThreshold": 1
      }
    ]
  }
}

getSymXInstancePagedListSelectFields

post

Retrieve getSymXInstancePagedListSelectFields data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getSymXInstancePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 548

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true,
    "SymXInstanceFields": {
      "CrudLoggingThreshold": true,
      "Description": true,
      "InstanceId": true,
      "InternalListSize": true,
      "InternalProviderKeyStore": true,
      "Name": true,
      "OtherLoggingThreshold": true,
      "PowerOnLoggingThreshold": true,
      "TokenValidity": true,
      "TransactionsLoggingThreshold": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXInstance": [
    {
      "InstanceId": 1,
      "CrudLoggingThreshold": 1,
      "Description": "text",
      "InternalListSize": 1,
      "InternalProviderKeyStore": "text",
      "Name": "text",
      "OtherLoggingThreshold": 1,
      "PowerOnLoggingThreshold": 1,
      "TokenValidity": 1,
      "TransactionsLoggingThreshold": 1
    }
  ],
  "Token": "text"
}

searchSymXInstancePagedSelectFields

post

Retrieve a paged list of select fields for SymX instances

Authorizations
Body
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchSymXInstancePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 563

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSymXInstanceFields": true,
    "SymXInstanceFields": {
      "CrudLoggingThreshold": true,
      "Description": true,
      "InstanceId": true,
      "InternalListSize": true,
      "InternalProviderKeyStore": true,
      "Name": true,
      "OtherLoggingThreshold": true,
      "PowerOnLoggingThreshold": true,
      "TokenValidity": true,
      "TransactionsLoggingThreshold": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SymXInstance": [
    {
      "InstanceId": 1,
      "CrudLoggingThreshold": 1,
      "Description": "text",
      "InternalListSize": 1,
      "InternalProviderKeyStore": "text",
      "Name": "text",
      "OtherLoggingThreshold": 1,
      "PowerOnLoggingThreshold": 1,
      "TokenValidity": 1,
      "TransactionsLoggingThreshold": 1
    }
  ],
  "Token": "text"
}
PreviousSymXGeneralNextSynapsysMrm

Last updated

Was this helpful?