Skip to main content

Import Metadata

Import a G&L metadata file using either a file located on the server or passed as the request body.

POST https://instance.securid.com/aveksa/command.submit?cmd=importMetadata

Request​

Parameters​

importMetadata
formatproperties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.

json - Useful format for parsing into javascript or other languages. See www.json.org for details.
filename

The filename in the import directory on the G&L server. The import directory is specified on the web services configuration page. Alternatively, the data can be sent as part of the request body.

This option is not recommended and file should be passed using the POST body
overwritetrue, false Indicates existing objects should be overwritten. (Default) false

Headers​

Bearer token
Acceptapplication/json
Content-Typeapplication/json

Body​

Metadata XML data

Response​

Parameters​

typeExecuted command name
statussuccess, failure
num-successThe number of objects successfully imported.
num-failureThe number of objects that failed to import.
messageOptional message to return along with the status.

Examples​

Request​

curl -L -X POST "https://instance.securid.com/aveksa/command.submit?cmd=importMetadata&overwrite=true" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token>" \
-d "<AveksaMetadataFile>
  <FileManifest>
    <exportDate>2023-08-30 20:44:38.238 UTC</exportDate>
    <systemVersion>7.5.2</systemVersion>
    <buildNumber>184537</buildNumber>
    <patches>P07_HF02</patches>
    <userName>AveksaAdmin</userName>
    <numberOfEntries>1</numberOfEntries>
    <entries>
      <entry objectType=\"CRButton\" name=\"Admin Access\" primaryKey=\"21\">
        <m__warnings/>
      </entry>
    </entries>
  </FileManifest>
  <ExportedCRButton>
    <databaseObject>
      <Properties>
        <Property name=\"sequenceNum\" type=\"java.lang.Integer\">16</Property>
        <Property name=\"name\" type=\"java.lang.String\">Admin Access</Property>
        <Property name=\"displayTypeStr\" type=\"java.lang.String\">Button</Property>
        <Property name=\"showUnderButtonName\" type=\"java.lang.String\"/>
        <Property name=\"actionStr\" type=\"java.lang.String\">RequestSourcesAdd</Property>
        <Property name=\"locRequests\" type=\"java.lang.String\">Y</Property>
        <Property name=\"locUserGeneral\" type=\"java.lang.String\">N</Property>
        <Property name=\"locUserAccess\" type=\"java.lang.String\">N</Property>
        <Property name=\"locDashboard\" type=\"java.lang.String\">N</Property>
        <Property name=\"availableForSpec\" type=\"java.lang.String\"/>
        <Property name=\"configStr\" type=\"java.lang.String\">&lt;map&gt;
  &lt;entry&gt;
    &lt;string&gt;includeForms&lt;/string&gt;
    &lt;boolean&gt;true&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;selfService&lt;/string&gt;
    &lt;boolean&gt;true&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;includeDataResourceSets&lt;/string&gt;
    &lt;boolean&gt;false&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;includeEntitlementViews&lt;/string&gt;
    &lt;boolean&gt;false&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;includeApplications&lt;/string&gt;
    &lt;boolean&gt;false&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;includeDirectories&lt;/string&gt;
    &lt;boolean&gt;false&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;includeBusinessUnitForms&lt;/string&gt;
    &lt;boolean&gt;false&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;includeRoleSets&lt;/string&gt;
    &lt;boolean&gt;false&lt;/boolean&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;formsFilter&lt;/string&gt;
    &lt;string&gt;forms.NAME in  (&amp;apos;Add Admin Access&amp;apos;)&lt;/string&gt;
  &lt;/entry&gt;
  &lt;entry&gt;
    &lt;string&gt;includeTerminated&lt;/string&gt;
    &lt;boolean&gt;false&lt;/boolean&gt;
  &lt;/entry&gt;
&lt;/map&gt;</Property>
      </Properties>
    </databaseObject>
  </ExportedCRButton>
</AveksaMetadataFile>"

Response​

{
    "data": {
        "type": "importMetadata",
        "status": "success",
        "num-success": "1",
        "num-failure": "0"
    }
}
Last updated on