Create a frequency table for a column
Creates a job, which gets the frequency for a single column in the loaded CAS table. The result is output to the new CAS table requested by the passed query parameters.
1{2 "version": 0,3 "id": "string",4 "state": "string",5 "results": {},6 "error": {7 "message": "string",8 "id": "string",9 "errorCode": 0,10 "httpStatusCode": 0,11 "details": [12 "string"13 ],14 "remediation": "string",15 "errors": [16 {}17 ],18 "links": [19 {20 "method": "string",21 "rel": "string",22 "uri": "string",23 "href": "string",24 "title": "string",25 "type": "string",26 "itemType": "string",27 "responseType": "string",28 "responseItemType": "string"29 }30 ],31 "version": 032 },33 "jobRequest": {34 "version": 0,35 "id": "string",36 "name": "string",37 "description": "string",38 "creationTimeStamp": "string",39 "modifiedTimeStamp": "string",40 "createdBy": "string",41 "modifiedBy": "string",42 "jobDefinitionUri": "string",43 "jobDefinition": {},44 "expiresAfter": "string",45 "arguments": {},46 "properties": {47 "property1": "string",48 "property2": "string"49 },50 "links": [51 {52 "method": "string",53 "rel": "string",54 "uri": "string",55 "href": "string",56 "title": "string",57 "type": "string",58 "itemType": "string",59 "responseType": "string",60 "responseItemType": "string"61 }62 ]63 },64 "heartbeatInterval": -2147483648,65 "heartbeatTimeStamp": "string",66 "creationTimeStamp": "string",67 "modifiedTimeStamp": "string",68 "endTimeStamp": "string",69 "expirationTimeStamp": "string",70 "createdBy": "string",71 "modifiedBy": "string",72 "links": [73 {74 "method": "string",75 "rel": "string",76 "uri": "string",77 "href": "string",78 "title": "string",79 "type": "string",80 "itemType": "string",81 "responseType": "string",82 "responseItemType": "string"83 }84 ]85}
Name | Type | Required | Description |
---|---|---|---|
caslibName | string | true | The name of the Caslib containing the input table. |
columnName | string | true | The name of column for which frequency info is requested. |
serverName | string | true | The name of the server containing the input Caslib. |
tableName | string | true | The name of the input table for which column frequency is requested. |
Name | Type | Required | Description |
---|---|---|---|
outputTableScope | string | false | The scope of the output table. Valid values in include session and global. Defaults to global. Global caslibs can contain global and session tables. Session caslibs can only contain session tables. |
sessionId | string | false | The optional ID of the session containing the Caslib. If unspecified, only tables in global caslibs will be accessible. |
sortBy | string | false | The optional order by which to sort the results. If omitted, sorting is not performed. An ascending sort is more performant than a descending sort. Valid sort column names include: Frequency and FmtVar. Valid sort order values include: ascending and descending. When sorting by Frequency, the FmtVar is automatically used as the secondary ascending sort. Sample sortBy values: Value of sortByResult Frequency:ascendingsort by ascending Frequency, ascending FmtVar Frequency:descendingsort by descending Frequency, ascending FmtVar FmtVar:ascendingsort by ascending FmtVar FmtVar:descendingsort by descending FmtVar |
outputCaslibName | string | true | The name of the Caslib for the output CAS table. |
outputTableName | string | true | The name of output CAS table. The following columns of interest are in the output table: Column NameContent FrequencyThe frequency of the value FmtVarThe formatted value CharVarFor a character column, the unformatted value NumVarFor a numeric column, the unformatted value |
Status | Meaning | Description | ||
---|---|---|---|---|
201 | Created | The asynchronous job for obtaining column frequency was submitted. | Schema | |
404 | Not Found | The requested CAS server or Caslib does not exist. | ||
409 | Conflict | The request could not be completed due to a conflict with the current state of the resource. Details are included in the response body. |