Skip to content
NexumAPI Docs

AnalysisPlan⁠

Perform various operations for Symitar parameters.

Operations⁠

getAnalysisPlan⁠

POST

Retrieve AnalysisPlan parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AnalysisPlanIndexAnalysisPlanintegerrequired
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/parameter/getAnalysisPlan
POST /nexum/627/2022.01/parameter/getAnalysisPlan HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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

getAnalysisPlanSelectFields⁠

POST

Retrieve AnalysisPlan parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
AnalysisPlanIndexAnalysisPlanintegeroptional
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/parameter/getAnalysisPlanSelectFields
POST /nexum/627/2022.01/parameter/getAnalysisPlanSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "AnalysisPlanIndexAnalysisPlan": 0,
  "SelectableFields": {
    "IncludeAllAnalysisPlanFields": true
  }
}

getAnalysisPlanPagedList⁠

POST

Retrieve AnalysisPlan parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/parameter/getAnalysisPlanPagedList
POST /nexum/627/2022.01/parameter/getAnalysisPlanPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

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

getAnalysisPlanListSelectFields⁠

POST

Retrieve AnalysisPlan parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/parameter/getAnalysisPlanListSelectFields
POST /nexum/627/2022.01/parameter/getAnalysisPlanListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "SelectableFields": {
    "IncludeAllAnalysisPlanFields": true
  }
}

searchAnalysisPlanSelectFields⁠

POST

Search AnalysisPlan parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/parameter/searchAnalysisPlanSelectFields
POST /nexum/627/2022.01/parameter/searchAnalysisPlanSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllAnalysisPlanFields": true
  },
  "SearchFilter": {
    "Query": "string"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getAnalysisPlanPagedListSelectFields⁠

POST

Retrieve AnalysisPlan parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
Path Parameters
symstringrequired
Sym number
Responses
Tokenstringoptional
POST/nexum/{sym}/2022.01/parameter/getAnalysisPlanPagedListSelectFields
POST /nexum/627/2022.01/parameter/getAnalysisPlanPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "AnalysisPlanFields": {
      "IndexAnalysisPlan": true,
      "Plan": true,
      "DefinedCode": true
    }
  }
}