Load Dimension Members (Metadata) (External Source Models)

  • 1 minute(s) read
Prev Next

Load Dimension Members (Metadata) (External Source Models)

Use this API to load metadata to an external Data Source model. This API supports the import of level-based source dimension metadata. Support for the import of parent-child based source dimension metadata will be added in the future. Only a single dimension’s metadata can be imported per request.

POST /modeling/sourcemodel/metadata/load HTTP/1.1
Content-Type: application/xml
Accept-Type: application/xml
X-ACCESS-TOKEN:
 
<?xml version="1.0" encoding="UTF-8"?>
<load-metadata-payload>
<model-name>$ModelName</model-name>
<dimension-name>$DimensionName</dimension-name>
<delimiter>$Delimiter</delimiter>
<levels>$Levels</levels>
<dimension-members>
<dimension-member>$DimensionMembers</dimension-member>
</dimension-members>
</load-metadata-payload>

Parameters

  1. $ModelName: (type: string) Name of the model

  2. $DimensionName: (type: string) Name of the dimension

  3. $Delimiter: (type: string) Delimiter string used in levels and dimension member elements

  4. $Levels: (type: string) Delimiter separated levels

  5. $DimensionMembers: (type: string) Delimiter separated dimension members

  6. $Level3Member: (type: string) Name of a member at Level3 (levels can be nested up to Level10)

Sample Payload

<?xml version="1.0" encoding="UTF-8"?>
<load-metadata-payload>
<model-name>My Model</model-name>
<dimension-name>Time</dimension-name>
<delimiter>@@</delimiter>
<levels>LEVEL1@@LEVEL3@@LEVEL2</levels>
<dimension-members>
<dimension-member>Q1 2013@@Q3 2013@@Q2 2013</dimension-member>
</dimension-members>
</load-metadata-payload>

Response

Success Response

HTTP/1.1 200/204 OK

Error Responses

Service Not Available (possibly due to maintenance)

HTTP/1.1 503 Service Unavailable

One or more HTTP headers were missing

HTTP/1.1 412 Precondition Failed

Unauthorized Access (access key lookup failed)

HTTP/1.1 401 Unauthorized

Invalid XML (bad request)

HTTP/1.1 400 Bad Request

Not Found (source model not found)

HTTP/1.1 404 Not Found

Resource Exists (metadata dimension exists)

HTTP/1.1 409 Conflict