Retrieve directories

/dam/dirs/retrieve Retrieves a list of sub-directories of the given RNC or directory. .Details

Resource path

/api/core/v1/dam/dirs/retrieve

HTTP method

POST

Request content type

application/json

Response content type

  • application/xml; charset=UTF-8;

  • application/json

  • application/json+compact
Body parameters

Specified by DirectoryRequest

  • rncTid: it might be used to get a top level directories within the given RNC

  • dirTid: it might be used to get a list of directories

  • dirPath: it might be used to get a list of directories

  • level: it sets how many directory level should be loaded Default value is 1. "-1" means to load all levels. 0 (zero) - is invalid value

Return Type

PimType with filled DirectoriesType. More info DirectoryType

Responses
Table 1. Http response codes
Code Message Datatype

200

PimType with filled DirectoriesType

PimType

400

Invalid input provided

ResponseType

401

Not authorized

ResponseType

404

Not found

ResponseType

500

An unknown internal error occurred

ResponseType
Samples
Please use transform endpoint to get the JSON/compact-JSON samples from the XML one.
1. To get a list of directories of a given RNC using rncTid parameter
curl 
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rncTid": "MAM",
    "level": 1
}'
Request body
{
    "rncTid": "MAM",
    "level": 1
}
Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
    <meta>
        <itm key="messageType">request</itm>
        <itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
        <itm key="sourceEnv">web</itm>
    </meta>
    <dirs>
        <dir tid="tid1" rnc="DATA">
            <name>directory1</name>
            <meta>
                <itm key="discriminator">DIR</itm>
                <itm key="identity">26576991</itm>
                <itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
                <itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
            </meta>
        </dir>
        <dir tid="tid2" rnc="DATA">
            <name>directory2</name>
            <meta>
                <itm key="discriminator">DIR</itm>
                <itm key="identity">26576992</itm>
                <itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
                <itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
            </meta>
        </dir>
    </dirs>
</pim>
2. To get a list of directories of a given RNC using dirPath parameter
curl 
curl --location --request POST 'https://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dirPath": "/DATA",
    "level": 1
}'
Request body
{
    "dirPath": "/DATA",
    "level": 1
}
Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
    <meta>
        <itm key="messageType">request</itm>
        <itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
        <itm key="sourceEnv">web</itm>
    </meta>
    <dirs>
        <dir tid="tid1" rnc="DATA">
            <name>directory1</name>
            <meta>
                <itm key="discriminator">DIR</itm>
                <itm key="identity">26576991</itm>
                <itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
                <itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
            </meta>
        </dir>
        <dir tid="tid2" rnc="DATA">
            <name>directory2</name>
            <meta>
                <itm key="discriminator">DIR</itm>
                <itm key="identity">26576992</itm>
                <itm key="creationDate">2019-05-03T15:50:55.664Z</itm>
                <itm key="modificationDate">2020-02-14T17:58:59.275Z</itm>
            </meta>
        </dir>
    </dirs>
</pim>
3. To get a list of sub-directories of a directory by dirTid parameter:
curl 
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dirTid": "2401C4CE-D223-4C3B-AE20-6260DFA6ECC5",
    "level": 1
}'
Request body
{
    "dirTid": "2401C4CE-D223-4C3B-AE20-6260DFA6ECC5",
    "level": 1
}
Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
    <meta>
        <itm key="messageType">request</itm>
        <itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
        <itm key="sourceEnv">web</itm>
    </meta>
    <dirs>
        <dir tid="tid1" parent="tid0">
            <name>directory1</name>
            <meta>
                ...
            </meta>
        </dir>
        <dir tid="tid1.1" parent="tid1">
            <name>directory1.1</name>
            <meta>
                ...
            </meta>
        </dir>
        <dir tid="tid2" parent="tid0">
            <name>directory2</name>
            <meta>
                ...
            </meta>
        </dir>
    </dirs>
</pim>
4. To get a list of sub-directories of a directory by dirPath parameter:
curl 
curl --location --request POST 'http://<OMN_SERVER>/api/core/v1/dam/dirs/retrieve' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dirPath": "2401C4CE-D223-4C3B-AE20-6260DFA6ECC5",
    "level": 1
}'
Request body
{
    "dirPath": "/DATA/assets",
    "level": 1
}
Response body
<?xml version="1.0" encoding="UTF-8"?>
<pim xmlns="http://www.apollon.de/omn" schemaVersion="5.6.0">
    <meta>
        <itm key="messageType">request</itm>
        <itm key="messageTime">2022-03-22T11:14:11.882Z</itm>
        <itm key="sourceEnv">web</itm>
    </meta>
    <dirs>
        <dir tid="tid1" parent="tid0">
            <name>directory1</name>
            <meta>
                ...
            </meta>
        </dir>
        <dir tid="tid1.1" parent="tid1">
            <name>directory1.1</name>
            <meta>
                ...
            </meta>
        </dir>
        <dir tid="tid2" parent="tid0">
            <name>directory2</name>
            <meta>
                ...
            </meta>
        </dir>
    </dirs>
</pim>

Welcome to the AI Chat!

Write a prompt to get started...