Each File contains no. of File Columns in it and this service deals with File Column related APIs.
The following are the operational APIs associated with the File Column Services API:
1. Get File Columns by File
The Get File Columns by File method get by given File Id if any exists.
Mandatory Field: fileId
|
Method |
Url |
Parameter |
|
getFileColumns |
/api/{fileId}/fileColumns |
{fileId} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"fileColumnList": [
{
"fileColumnId": 45,
"fileId": 1023,
"columnName": "date",
"columnType": "Date",
"columndescription": "date",
"beavercolumntype": null,
"minvalue": "7/1/2014",
"maxvalue": "9/28/2014",
"columnscore": 0,
"usescore": 0,
"displayeligible": 0,
"columnLength": 9,
"nullcount": 0,
"distinctcount": 82,
"typestats": null,
"topvalues": "{\"9/10/2014\":1,\"8/19/2014\":1,\"8/31/2014\":1,\"7/30/2014\":1,\"8/20/2014\":1,\"7/13/2014\":1,\"7/18/2014\":1,\"9/26/2014\":1,\"8/15/2014\":1,\"7/12/2014\":1,\"9/24/2014\":1,\"8/11/2014\":1,\"8/9/2014\":1,\"8/12/2014\":1,\"8/17/2014\":1,\"7/22/2014\":1,\"9/12/2014\":1,\"9/28/2014\":1,\"9/20/2014\":1,\"9/25/2014\":1,\"8/7/2014\":1}",
"mask": 0,
"restricted": 0,
"columnposition": 0,
"active": 1,
"audit": 0,
"maxUseScore": 0,
"maxColumnScore": 0,
"firsthundred": null,
"businessGlossaryId": 0,
"patternStats": null,
"inProject": false
},
{
"fileColumnId": 43,
"fileId": 1023,
"columnName": "time",
"columnType": "String",
"columndescription": "time",
"beavercolumntype": null,
"minvalue": "10:00 AM",
"maxvalue": "9:00 PM",
"columnscore": 0,
"usescore": 0,
"displayeligible": 0,
"columnLength": 8,
"nullcount": 0,
"distinctcount": 94,
"typestats": null,
"topvalues": "{\"3:15 AM\":1,\"3:50 PM\":1,\"1:00 AM\":1,\"1:10 PM\":1,\"6:45 PM\":1,\"6:25 AM\":1,\"11:45 AM\":1,\"5:25 PM\":1,\"2:15 PM\":1,\"1:45 PM\":1,\"5:15 AM\":1,\"9:05 PM\":1,\"10:20 PM\":1,\"1:25 PM\":1,\"1:50 PM\":1,\"10:45 PM\":1,\"12:35 PM\":1,\"3:00 AM\":1,\"6:25 PM\":1,\"8:40 PM\":1,\"10:15 PM\":1,\"12:15 AM\":1,\"6:10 AM\":1,\"9:50 PM\":1,\"7:45 PM\":1,\"7:15 AM\":1,\"1:15 PM\":1,\"6:55 AM\":1,\"12:55 PM\":1,\"6:20 AM\":1,\"4:15 AM\":1,\"4:40 PM\":1,\"11:05 AM\":1,\"6:15 AM\":1,\"8:45 PM\":1,\"7:10 AM\":1,\"6:05 PM\":1,\"12:15 PM\":1,\"10:40 PM\":1,\"10:00 PM\":1,\"4:15 PM\":1,\"11:20 PM\":1}",
"mask": 0,
"restricted": 0,
"columnposition": 1,
"active": 1,
"audit": 0,
"maxUseScore": 0,
"maxColumnScore": 0,
"firsthundred": null,
"businessGlossaryId": 0,
"patternStats": null,
"inProject": false
}
]
}
}
2. Delete File Column
(NOTE: Will be completed in next Release)
The Delete File Column By Id method deletes File Column by input Id if it exists.
|
Method |
Url |
Parameter |
|
deleteFileColumn |
/api/deletefileColumn/{fileColumnId} |
{fileColumnId} |
Response
{
"status": true,
"statusCode": "FileColumn is deleted with fileFolderId 50",
"statusMsg": "",
"response": {}
}
3. Save File Column
(Note: This method is deprecated. To create a File Column, you should use crawlers in OvalEdge application)
The Save File Column method creates a FileColumn with given input through the Request body.
Mandatory Field: connectionInfoId, fileColumnId, fileId, filecolumnName, filecolumnType
|
Method |
Url |
|
saveFileColumn |
/api/fileColumn |
Note: active must be 1.
Request Body
{
"active": 0, *
"fileColumnId": 0,
"fileId": 0, *
"filecolumnDescription": "string",
"filecolumnLength": 0, *
"filecolumnName": "string",*
"filecolumnType": "string"*
}
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"fileColumn": {
"fileColumnId": 50,
"fileId": 1022,
"columnName": "sampleTestColumn",
"columnType": "String",
"columndescription": "sampleTestColumnDescription",
"beavercolumntype": null,
"minvalue": null,
"maxvalue": null,
"columnscore": 0,
"usescore": 0,
"displayeligible": 1,
"columnLength": 9999,
"nullcount": 0,
"distinctcount": 0,
"typestats": null,
"topvalues": null,
"mask": 0,
"restricted": 0,
"columnposition": 0,
"active": 1,
"audit": 0,
"maxUseScore": 0,
"maxColumnScore": 0,
"firsthundred": null,
"businessGlossaryId": null,
"patternStats": null,
"inProject": false
}
}
}
4. Get File Column By Id
The Get File Column By Id method returns File Column by input Id if it exists.
Mandatory Field: fileColumnId
|
Method |
Url |
Parameter |
|
getFileColumnbyId |
/api/fileColumn/{fileColumnId} |
{fileColumnId} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"fileColumn": {
"fileColumnId": 49,
"fileId": 1023,
"columnName": "Status",
"columnType": "String",
"columndescription": "Status",
"beavercolumntype": null,
"minvalue": "Arrived",
"maxvalue": "Assigned",
"columnscore": 0,
"usescore": 0,
"displayeligible": 0,
"columnLength": 9,
"nullcount": 0,
"distinctcount": 3,
"typestats": null,
"topvalues": "{\"Assigned\":118,\"Arrived\":128,\"Cancelled\":29}",
"mask": 0,
"restricted": 0,
"columnposition": 6,
"active": 1,
"audit": 0,
"maxUseScore": 0,
"maxColumnScore": 0,
"firsthundred": null,
"businessGlossaryId": 0,
"patternStats": null,
"inProject": false
}
}
}