Archivo JSON para la API de exportación

La API de exportación utiliza un archivo JSON como archivo de parámetros. Cada proceso de exportación se define como una clave en el archivo JSON, con objetos asociados especificados según la configuración seleccionada.

En la Swagger UI, la sección POST proporciona documentación detallada sobre la estructura y las entradas necesarias del archivo de parámetros JSON.

El área para el archivo JSON incluye dos pestañas: Edit value y Model.

Pestaña Edit value: Se utiliza para modificar el contenido del archivo JSON.
Pestaña Model: Utilícela para ver documentación detallada sobre los parámetros previstos y sus formatos durante la edición.

Imagen: Swagger UI, documentación

La flecha a la derecha junto a una entrada indica que hay documentación más detallada para esta entrada. Haga clic en las flechas para ampliar y ver la información detallada.

A continuación encontrará un ejemplo del archivo JSON.

Ejemplo de archivo JSON

{
    "exportContents": {
        "adminLog": {
            "last_x_days": 365
        },
        "assetState": {},
        "componentLog": {
            "timeStampFilter": {
                "filterFrom": "2023-01-01T00:00:00Z"
            }
        },
        "componentTypes": {},
        "componentsWithStdLibAssignments": {},
        "eventLog": {
            "max_lines": 10000,
            "timeStampFilter": {
                "filterFrom": "2023-01-01T00:00:00Z"
            }
        },
        "jobList": {
            "csvSeparator": "TAB",
            "includeComponentsWithoutJobs": true
        },
        "jobResults": {
        },
        "projectTree": {
            "includeMasterData": true,
            "versionInformation": "VERSION_INFORMATION_ALL"
        },
        "standardLibraryManagement": {
            "exportType": "JSON",
            "flat_export": true
        },
        "unequalJobResults": {},
        "userManagement": {
            "exportType": "XML",
            "grouping": "GROUP_BY_USERS",
            "includeDeletedUsers": true
        }
    }
}

Contenido relacionado

Interfaz Swagger