Update a Data Manager Entity

post/datamart.updatefc/{TypeCode}

Updates and deploys a field collection (FC) definition - Data Feed (DMF), Datamart (DM), or Data Source (DMDS).

Information: If Data Source (DMDS) is added or updated, then a Data Feed (DMF) is created for the corresponding Data Source.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

The type code of the Field Collection you want to update.

Possible values: "DMF" "DM" "DMDS"
Example: DM
Request Body schema: application/json

Either uniqueName or typedId must be provided in the request.

operationType
string non-empty
object
version
number
typedId
required
string non-empty
uniqueName
required
string non-empty
label
string non-empty
sourceFile
any
required
Array of objects non-empty unique
Array (non-empty)
name
string non-empty
label
string non-empty
labelTranslations
object
rank
number
format
any
measureType
any
functionalType
any
visibility
number
defaultValue
any
sourceField
any
expression
string non-empty
function
any
formulaElement
any
messages
any
key
boolean
system
boolean
numeric
boolean
deleted
boolean
persisted
boolean
dimension
boolean
calculated
boolean
dbColumn
string non-empty
aggregation
boolean
time
boolean
partitioningKey
boolean
queryable
boolean
auxiliary
boolean
deployed
boolean
dbTable
string non-empty
type
string non-empty
source
string non-empty
owningFC
string non-empty
hidden
boolean
keyFields
Array of strings
formulaName
any
reload
boolean
messages
any
reservedWords
any
rowCount
any
lastUpdateByName
string non-empty
defaultDataSourceName
string non-empty
lineSeperator
any
fieldSeperator
any
quoteChar
any
fetchVerb
string non-empty
integrateVerb
any
bulkloadVerb
string non-empty
identikitCriteria
any
draft
boolean
queryable
boolean
view
boolean
sourceName
string non-empty
type
string non-empty
valid
boolean
status
any
targetDate
any
calculationMessages
any
loadableFields
Array of strings
auxiliary
boolean
deployed
boolean

Set to true if the matching tables were created/updated.

dbTable
string non-empty
dbKey
string
dbView
any
locked
boolean
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
query
any
lastDataModificationDate
string non-empty
typeCode
any
isPlasma
boolean
calculationStartDate
any
calculationDate
any
Responses
200

Example response

Response Schema: application/json
object
node
string non-empty
csrfToken
string non-empty
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
uniqueName
string non-empty
label
string non-empty
fields
Array of objects
keyFields
Array of objects
lastUpdateByName
string non-empty
fetchVerb
string non-empty
bulkloadVerb
string non-empty
type
string non-empty
queryable
boolean
view
boolean
sourceName
string non-empty
draft
boolean
locked
boolean
valid
boolean
fieldNames
Array of objects
keyFieldNames
Array of objects
deployed
boolean
auxiliary
boolean
loadableFields
Array of objects
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
isPlasma
boolean
endRow
number
status
number
Request samples
application/json
{
  • "operationType": "update",
  • "data": {
    • "version": 4,
    • "typedId": "2147483684.DMF",
    • "uniqueName": "Meatball_transaction",
    • "label": "Meatball_transaction",
    • "sourceFile": null,
    • "fields": [
      • {
        • "name": "attribute1",
        • "label": "InvoiceDate",
        • "labelTranslations": { },
        • "rank": 1,
        • "format": null,
        • "measureType": null,
        • "functionalType": null,
        • "visibility": 1,
        • "defaultValue": null,
        • "sourceField": null,
        • "expression": "attribute1",
        • "function": null,
        • "formulaElement": null,
        • "messages": null,
        • "key": false,
        • "system": false,
        • "numeric": false,
        • "deleted": false,
        • "persisted": true,
        • "dimension": false,
        • "calculated": false,
        • "dbColumn": "attribute1",
        • "aggregation": false,
        • "time": false,
        • "partitioningKey": false,
        • "queryable": true,
        • "auxiliary": false,
        • "deployed": true,
        • "dbTable": "seeddata_DMF_Meatball_transaction",
        • "type": "TEXT",
        • "source": "DMF.Meatball_transaction",
        • "owningFC": "Meatball_transaction",
        • "hidden": false
        },
      • {
        • "name": "completeResultsAvailable",
        • "label": "Details",
        • "labelTranslations": { },
        • "rank": 36,
        • "format": null,
        • "measureType": null,
        • "functionalType": null,
        • "visibility": 0,
        • "defaultValue": null,
        • "sourceField": null,
        • "expression": "NOT ISNULL(formulaDetailedResults)",
        • "function": null,
        • "formulaElement": null,
        • "messages": null,
        • "key": false,
        • "system": true,
        • "numeric": false,
        • "deleted": false,
        • "persisted": false,
        • "dimension": false,
        • "calculated": true,
        • "dbColumn": "attribute1",
        • "aggregation": false,
        • "time": false,
        • "partitioningKey": false,
        • "queryable": true,
        • "auxiliary": true,
        • "deployed": false,
        • "dbTable": "seeddata_DMF_Meatball_transaction",
        • "type": "BOOLEAN",
        • "source": "DMF.Meatball_transaction",
        • "owningFC": "[System]",
        • "hidden": true
        }
      ],
    • "keyFields": [ ],
    • "formulaName": null,
    • "reload": false,
    • "messages": null,
    • "reservedWords": null,
    • "rowCount": null,
    • "lastUpdateByName": "ondrej.tesar",
    • "defaultDataSourceName": "DMDS.Meatball_transaction",
    • "lineSeperator": null,
    • "fieldSeperator": null,
    • "quoteChar": null,
    • "fetchVerb": "datamart.fetch/2147483684.DMF",
    • "integrateVerb": null,
    • "bulkloadVerb": "datamart.loaddata/Meatball_transaction",
    • "identikitCriteria": null,
    • "draft": false,
    • "queryable": true,
    • "view": false,
    • "sourceName": "DMF.Meatball_transaction",
    • "type": "FEED",
    • "valid": true,
    • "status": null,
    • "targetDate": null,
    • "calculationMessages": null,
    • "loadableFields": [
      • "attribute1",
      • "attribute2",
      • "attribute3",
      • "attribute4",
      • "attribute5",
      • "attribute6",
      • "attribute7",
      • "attribute8",
      • "attribute9",
      • "attribute10",
      • "attribute11",
      • "attribute12",
      • "attribute13",
      • "attribute14",
      • "attribute15",
      • "attribute16",
      • "attribute17",
      • "attribute18",
      • "attribute19",
      • "attribute20",
      • "attribute21",
      • "attribute22",
      • "attribute23",
      • "attribute24",
      • "attribute25",
      • "attribute26",
      • "attribute27"
      ],
    • "auxiliary": false,
    • "deployed": true,
    • "dbTable": "seeddata_DMF_Meatball_transaction",
    • "dbKey": "",
    • "dbView": null,
    • "locked": false,
    • "createDate": "2018-10-04T17:09:00",
    • "createdBy": 2147483649,
    • "lastUpdateDate": "2021-12-03T13:34:00",
    • "lastUpdateBy": 2147490187,
    • "query": null,
    • "lastDataModificationDate": "2021-12-02T00:09:03",
    • "typeCode": null,
    • "isPlasma": false,
    • "calculationStartDate": null,
    • "calculationDate": null
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "node",
    • "csrfToken": "tkn",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "2147483813.DMF",
        • "uniqueName": "Feed",
        • "label": "Feed",
        • "fields": [ ],
        • "keyFields": [ ],
        • "lastUpdateByName": "admin",
        • "fetchVerb": "datamart.fetch/2147483813.DMF",
        • "bulkloadVerb": "datamart.loaddata/Feed",
        • "type": "FEED",
        • "queryable": true,
        • "view": false,
        • "sourceName": "DMF.Feed",
        • "draft": false,
        • "locked": false,
        • "valid": true,
        • "fieldNames": [ ],
        • "keyFieldNames": [ ],
        • "deployed": false,
        • "auxiliary": false,
        • "loadableFields": [ ],
        • "createDate": "2021-12-02T16:37:01",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-12-02T16:37:01",
        • "lastUpdateBy": 2147490696,
        • "isPlasma": false
        }
      ],
    • "endRow": 1,
    • "status": 0
    }
}