List Data Manager Entities

post/datamart.getfcs/{TypeCode}

Retrieves Data Manager Entities (Field Collections), including object's metadata. A filter can be applied.

Action Endpoint
List Data Feeds /datamart.getfcs/DMF
List Data Sources /datamart.getfcs/DMDS
List Datamarts /datamart.getfcs/DM
List Datamart Model Tables /datamart.getfcs/DMT
List Data Loads Use a different endpoint to retrieve Data Loads: /datamart.getdataloads
Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

The type code of the Field Collection.

Possible values: "DM" "DMDS" "DMF" "DMT"
Example: DM
Request Body schema: application/json
object
_constructor
string non-empty
operator
string non-empty
Array of objects non-empty unique
Array (non-empty)
fieldName
string non-empty

Specify a name of the field of the DM entity.

operator
string non-empty

Specify an operator of the filter criteria.

Possible values: "equals" "iEquals" "notEqual" "iNotEqual" "isNull" "notNull" "contains" "iContains" "containsPattern" "iContainsPattern" "notContains" "iNotContains" "startsWith" "iStartsWith" "notStartsWith" "iNotStartsWith" "endsWith" "iEndsWith" "notEndsWith" "iNotEndsWith" … 4 more
value
string non-empty
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
{
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "lastUpdateBy",
        • "operator": "equals",
        • "value": "2147490696"
        }
      ]
    }
}
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
    }
}