Metadata

The Medadata segment is accessed through the System controller. Actions taken on a resource determine the type of action that can be performed.

The following table shows the actions that can be taken on each resource, including the URI and object type of the resource.

Segment

Resource

URI

$filter

$select

$top

$skip

$orderby

Application

application - by id

/system/application/applicationid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

application - all

/system/application

Help available

Help available

Help available

Help available

Help available

 

application version

/system/applicationinfo/version

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Event

event action - by id

/system/eventaction/eventactionid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

event action - by event rule

/system/eventaction/eventrule/eventruleid

Help available

Help available

Help available

Help available

Help available

 

event rule - by ID

/system/eventrule/eventruleid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

event rule - by level

/system/eventrule/level/levelid

Help available

Help available

Help available

Help available

Help available

Field

field content - by field ID

/system/content/fieldcontent

Help available

Help available

Help available

Help available

Help available

 

field definition - by ID

/system/fielddefinition/fieldid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

field definition - by application ID

/system/fielddefinition/application/*applicationid*

Help available

Help available

Help available

Help available

Help available

 

field definition - by level

/system/fielddefinition/level/levelid

Help available

Help available

Help available

Help available

Help available

 

field definition - by level for ValuesList

/system/fielddefinition/level/levelid/valueslist

Help available

Help available

Help available

Help available

Help available

 

field display - by level

/system/fielddisplay/level/levelid

Help available

Help available

Help available

Help available

Help available

 

field id - by eventrule filter by level

api/system/field/eventrulefilter/level/levelId

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Level

level - by id

/system/level/levelid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

level - by module

/system/level/module/moduleid

Help available

Help available

Help available

Help available

Help available

 

level - by reference field

/system/level/referencefield/fieldid

Help available

Help available

Help available

Help available

Help available

 

level - all

/system/level

Help available

Help available

Help available

Help available

Help available

 

level layout - by level id

/system/levellayout/levelid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

Questionnaire

questionnaire - by id

/system/questionnaire/questionnaireid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

questionnaire - all

/system/questionnaire

Help available

Help available

Help available

Help available

Help available

 

questionnaire rule - by id

/system/questionnairerule/id

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

questionnaire rule - by level

/system/questionnairerule/level/levelid

Help available

Help available

Help available

Help available

Help available

Security

security parameter - by id

/system/securityparameter/securityparameterid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

security parameter - all

/system/securityparameter

Help available

Help available

Help available

Help available

Help available

 

security parameter - create

/system/securityparameter

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

security parameter - update

/system/securityparameter

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

security parameter - delete

/system/securityparameter/*securityparameterid*

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Subform

subform - by id

/system/subform/subformid

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

Values List

values list definition - by id

/system/valueslist/id

Help unavailable

Help available

Help unavailable

Help unavailable

Help unavailable

 

values list value - by values list id (flat)

/system/valueslistvalue/flat/valueslist/valueslistid

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

 

values list value - by values list id (hierarchical)

/system/valueslistvalue/valueslist/valueslistid

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Help unavailable

Note: The following properties are allowed with the $filter, $select, and the $orderby actions in the OData query on the field definition resources available in the table above:

  • Id
  • LevelId
  • Type
  • Name
  • Alias
  • IsActive
  • Guid
  • ASOStatus
  • SystemType
  • IsPrivate
  • IsContentReadOnly
  • EsFieldMappingId
  • UpdateInformation
  • FieldMap