ImesI

<back to all web services

MetadataRequest

The following routes are available for this service:
GET/mdactions/{ObjType}
MetadataRequest Parameters:
NameParameterData TypeRequiredDescription
ObjTypepathstringNo
MetadataResponse Parameters:
NameParameterData TypeRequiredDescription
activeformboolNo
keyTypeformstringNo
titleformstringNo
nameformstringNo
qinfoformstringNo
orderByformstringNo
columnsformList<MetadataColumn>No
statesformDictionary<string, MetadataState>No
actionsformDictionary<string, MetadataAction>No
querysformDictionary<string, string>No
MetadataColumn Parameters:
NameParameterData TypeRequiredDescription
orderformintNo
activeformboolNo
extformboolNo
nameformstringNo
titleformstringNo
actionformstringNo
isnumformboolNo
orderByformstringNo
filterformstringNo
htmlformstringNo
classformstringNo
MetadataState Parameters:
NameParameterData TypeRequiredDescription
routeformstringNo
titleformstringNo
getformstringNo
exportformstringNo
getelemformstringNo
extrainfoformstringNo
columnsformList<string>No
querysformList<string>No
elemsformList<ElemToLoad>No
getparamsformstringNo
templateformstringNo
filterformstringNo
controllerformstringNo
consumerformstringNo
stateformStateNo
elemActionsformList<string>No
multiElemActionsformList<string>No
actionsformList<string>No
numactformintNo
ElemToLoad Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
urlformstringNo
State Parameters:
NameParameterData TypeRequiredDescription
viewingformboolNo
editingformboolNo
columnsToRemoveformList<string>No
MetadataAction Parameters:
NameParameterData TypeRequiredDescription
hotkeyformstringNo
hotkeyTitleformstringNo
classNameformstringNo
parentformstringNo
rolesformList<string>No
enablePolicyformEnablePolicyNo
nameformstringNo
iconformstringNo
routeformstringNo
internalActionformstringNo
confirmMessageformstringNo
actionformList<Dictionary<String,String>>No
actionsformList<ActionInfo>No
EnablePolicy Enum:
never
allways
perItem
ActionInfo Parameters:
NameParameterData TypeRequiredDescription
nameformActionNameNo
urlformstringNo
ActionName Enum:
get
put
post
postUpload
postNoData
delete
back
refresh
route
open_url
message
HTMLmessage
prompt

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /mdactions/{ObjType} HTTP/1.1 
Host: gpv.ocellot.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MetadataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceApp.ActionsMetadata">
  <actions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringMetadataActionGwNHsPbe>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <action>
          <d2p1:ArrayOfKeyValueOfstringstring>
            <d2p1:KeyValueOfstringstring>
              <d2p1:Key>String</d2p1:Key>
              <d2p1:Value>String</d2p1:Value>
            </d2p1:KeyValueOfstringstring>
          </d2p1:ArrayOfKeyValueOfstringstring>
        </action>
        <actions>
          <ActionInfo>
            <name>get</name>
            <url>String</url>
          </ActionInfo>
        </actions>
        <className>String</className>
        <confirmMessage>String</confirmMessage>
        <enablePolicy>never</enablePolicy>
        <hotkey>String</hotkey>
        <hotkeyTitle>String</hotkeyTitle>
        <icon>String</icon>
        <internalAction>String</internalAction>
        <name>String</name>
        <parent>String</parent>
        <roles>
          <d2p1:string>String</d2p1:string>
        </roles>
        <route>String</route>
      </d2p1:Value>
    </d2p1:KeyValueOfstringMetadataActionGwNHsPbe>
  </actions>
  <active>false</active>
  <columns>
    <MetadataColumn>
      <action>String</action>
      <active>false</active>
      <class>String</class>
      <ext>false</ext>
      <filter>String</filter>
      <html>String</html>
      <isnum>false</isnum>
      <name>String</name>
      <order>0</order>
      <orderBy>String</orderBy>
      <title>String</title>
    </MetadataColumn>
  </columns>
  <keyType>String</keyType>
  <name>String</name>
  <orderBy>String</orderBy>
  <qinfo>String</qinfo>
  <querys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </querys>
  <states xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringMetadataStateGwNHsPbe>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>
        <actions>
          <d2p1:string>String</d2p1:string>
        </actions>
        <columns>
          <d2p1:string>String</d2p1:string>
        </columns>
        <consumer>String</consumer>
        <controller>String</controller>
        <elemActions>
          <d2p1:string>String</d2p1:string>
        </elemActions>
        <elems>
          <ElemToLoad>
            <name>String</name>
            <url>String</url>
          </ElemToLoad>
        </elems>
        <export>String</export>
        <extrainfo>String</extrainfo>
        <filter>String</filter>
        <get>String</get>
        <getelem>String</getelem>
        <getparams>String</getparams>
        <multiElemActions>
          <d2p1:string>String</d2p1:string>
        </multiElemActions>
        <numact>0</numact>
        <querys>
          <d2p1:string>String</d2p1:string>
        </querys>
        <route>String</route>
        <state>
          <columnsToRemove>
            <d2p1:string>String</d2p1:string>
          </columnsToRemove>
          <editing>false</editing>
          <viewing>false</viewing>
        </state>
        <template>String</template>
        <title>String</title>
      </d2p1:Value>
    </d2p1:KeyValueOfstringMetadataStateGwNHsPbe>
  </states>
  <title>String</title>
</MetadataResponse>