Dissemination API

GET /aip/{packageId}

GET /fileplan

GET /fileplan/{packageId}

GET /search

GET /search/{searchConfig}

{
  "totalResults": 123,            // Total number of packages matching the query
  "page": 0,                      // Current page number
  "pageSize": 100,                // Number of items per page
  "items": [
    {
      // Each item is an AIP object, see AIP Schema below
    }
  ]
}

{
  "packageId": "uuid-1234",        // Unique identifier for the package
  "packageType": "AIP",            // Type of the package (e.g., AIP)
  "pluginReports": [               // List of plugin execution reports
    {
      "executionDate": "2023-01-01T00:00:00Z", // Date/time of plugin execution
      "pluginName": "examplePlugin",           // Name of the plugin
      "message": "Plugin executed successfully", // Execution message
      "status": "SUCCESS"                      // Plugin status (SUCCESS, WARNING, FAILURE)
    }
  ],
  "permissions": [                 // Permissions available to the current user
  ],
  "title": "Sample Package",       // Title of the package
  "searchcolumns": { // Key Value pairs of all the columns from search config
    "hr-doc:category": "Contract",
    "hr-doc:expiryDate": "2025-11-05T23:00:00.000Z",
    "hr-doc:department": "CSS",
    "hr-doc:employeeId": "mark.janssens",
    "hr-doc:title": "Contract Mark Janssens - 2019-07-13"
  },
  "metadata": {
    // See MetadataSection Schema below
    "schema": "exampleSchema",     // Metadata schema name
    "fields": {                    // Key-value pairs containing metadata
      "key": "value"               // Example field
    }
  },
  "representations": [
    {
      "id": "rep-1",             // Unique identifier for the representation
      "metadata": {
        // See MetadataSection Schema
        "schema": "repSchema",   // Representation metadata schema name
        "fields": {}             // Representation metadata fields
      },
      "data": [
        {
          "url": "https://example.com/file", // URL for the representation data
          "format": "pdf"                    // Format of the file (e.g., pdf, jpg)
        }
      ]
    }
  ],
  "breadcrumb": [
    {
      "title": "Home",           // Breadcrumb title
      "packageId": "uuid-home"   // Package ID referenced in the breadcrumb
    }
  ]
}

{
  "schema": "exampleSchema",     // Name or identifier of the metadata schema
  "fields": {
    "fieldName": "value"         // Arbitrary key-value pairs for metadata fields
  }
}

{
  "id": "rep-1",               // Unique identifier for the representation
  "metadata": {
    "schema": "repSchema",     // Name or identifier for the representation metadata schema
    "fields": {
      "field": "value"         // Representation metadata field
    }
  },
  "data": [
    {
      "url": "https://example.com/file",    // URL of the representation data
      "format": "pdf"                       // Format of the file (e.g., pdf, jpg)
    }
  ]
}

{
  "title": "Sample Breadcrumb",     // Title for the breadcrumb navigation element
  "packageId": "uuid-breadcrumb"    // Associated package identifier
}

{
  "name": "defaultSearch",      // Name of the search configuration
  "limit": "100",               // Limit for the search results
  "offset": "0",                // Offset for search results
  "columns": [
    {
      "xpath": "field1",        // Key used to identify the column in the search results
      "label": "Field 1",       // Human-readable label for the column
      "dataType": "string",     // Data type for the column (string, number, boolean, date, datetime, object)
      "sortable": true,         // Indicates if the column is sortable
      "hidden": false,          // Indicates if the column should be hidden in the UI
      "visibleByDefault": true  // Indicates if the column should be visible by default in the UI ( useful if you have a column selector )
    }
  ],
  "filters": [
    {
        "filterName": "name",          // Key used to identify the filter ( this is what you should use in the search api )
        "filterMinName": "min_name"    // Key used as an identifier for the filter's min value ( only applicable when the Operator is "BETWEEN" )
        "filterMaxName": "max_name".   // Key used as an identifier for the filter's max value ( only applicable when the Operator is "BETWEEN" )
        "fields": [                    // Columns this filter applies to
            "field1", "field2"
        ],
        "label": "label1",      // Label for UI
        "dataType": "string",   // Possible Values : string, integer, decimal, date, datetime, boolean
        "operator": "FULLTEXT"  // Possible Values : FULLTEXT, LIKE, ILIKE, EQ, GT, GTEQ, LT, LTEQ, BETWEEN, AGGREGATE
    },
  ...
  ]
}

{
  "code": "ERROR_CODE",         // A short code identifying the error
  "message": "Error description"// A detailed description of the error
}