API-Vitam - Access version v1

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

• Accept: required(one of application/json, application/zip, application/octet-stream)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

• $roots: required(array of string)

  Contient les racines de la recherche

• $query: required(array of object)

  Contient plusieurs requêtes

  Items:
• $filter: (object)

  Contient les filtres à appliquer

  • $offset: (integer - minimum: 1 - maximum: 100000)
  • $limit: (integer - minimum: 1 - maximum: 100000)
  • $orderby: (object)
  • $track_total_hits: (boolean)

    Devrait être setté à "true", au niveau de la configuration, pour avoir une précision sur les résultats de recherche dépassant 10k données (par défaut "false").

• $projection: required(object)

  Contient la projection à appliquer

  • $fields: (object)
• $facet: (array of DslTypes.Facet)

  Contains facet if requested

  Items: Facet

  • $name: required(string)
  • $terms: (object)
    • $field: required(string)

      Example:

      #qualifiers.versions.FormatIdentification.MimeType

    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $size: required(number)

      Example:

      20

    • $order: required(string)

      Example:

      ASC

  • $filters: (object)
    • $query_filters: required(array of object)

      Items: items

      • $name: required(string)
      • $query: required(object)
  • $date_range: (object)
    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $field: required(string)

      Example:

      #qualifiers.versions.FileInfo.LastModified

    • $format: required(string)

      Example:

      YYYY

    • $ranges: required(array of object - minItems: 1 - maxItems: 2)

      Items: items

      • $from: required(string)

        Example:

        2017

      • $to: required(string)

        Example:

        2020

Example:

{
  "$roots": [],
  "$query": [
    {
      "$eq": {
        "#tenant": "0"
      }
    }
  ],
  "$filter": {
    "$limit": 5
  },
  "$projection": {
    "$fields": {
      "Title": 1
    }
  },
  "$facets": [
    {
      "$name": "ObjectTypeFacet",
      "$terms": {
        "$field": "DescriptionLevel",
        "$size": 20,
        "$order": "ASC"
      }
    }
  ]
}

Headers

• X-Http-Method-Override: (GET)
• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

Examples:

{
  "$roots": [],
  "$query": [ { "$eq": { "#id": "{{guid}}" } }
  ],
  "$action": [
    {
      "$setregex": {
        "$target": "Title",
        "$controlPattern": "Dessert placé",
        "$updatePattern": "Dessert glacé"
      }
    }
  ]
}

{
  "$roots": [],
  "$query": [
    {
      "$in": {
        "#id": [
          "MY-AU-GUID"
        ]
      }
    }
  ],
  "$threshold": 10000,
  "$action": [
    {
      "$set": {
        "Gps": {
          "GpsLatitude": "lat is here",
          "GpsLongitude": "long is here"
        }
      }
    }
  ]
}

{
  "$roots": [],
  "$query": [
    {
      "$in": {
        "#id": [
          "MY-AU-GUID"
        ]
      }
    }
  ],
  "$threshold": 10000,
  "$action": [
    {
      "$unset": [
        "Description"
      ]
    }
  ]
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

• Accept: required(one of application/json, application/zip, application/octet-stream)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

• $roots: required(array of string)

  Contient les racines de la recherche

• $query: required(array of object)

  Contient plusieurs requêtes

  Items:
• $projection: required(object)

  Contient la projection à appliquer

  • $fields: (object)

Example:

{
  "$roots": [],
  "$query": [
    {
      "$gt": {
        "#approximate_creation_date": "2022-01-01"
      }
    }
  ],
  "$projection": {
    "$fields": {
    }
  },
  "$facets": [],
  "$threshold": 500000
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

Example:

{
  "dslRequest": {
    "$roots": [],
    "$query": [ { "$eq": { "#id": "MY-AU-GUID" } } ],
    "$threshold": 10000
  },
  "ruleActions": {
    "add": [],
    "update": [],
    "delete": [
      {
        "HoldRule": {
          "Rules": [
            {
              "Rule": "HOL-00001"
            }
          ]
        }
      }
    ]
  }
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: any

Example:

{
  "$query": [
    {
      "$eq": {
        "#opi": "aeeaaaaaagfex4j4aaqcqalmjv7flpiaaaaq"
      }
    }
  ]
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: any

Example:

{
  "$query": [
    {
      "$eq": {
        "#opi": "aeeaaaaaagfex4j4aaqcqalmjv7flpiaaaaq"
      }
    }
  ]
}

URI Parameters

• idu: required(string)

  Identifiant de l'unité d'archive.

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

• Accept: required(one of application/json, application/zip, application/octet-stream)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

• $projection: (object)

  Contient la projection à appliquer

  • $fields: (object)

Example:

{
  "$projection": { "$fields": { "#id": 1, "title": 1, "#type": 1, "#parents": 1, "#object": 1 } }
}

URI Parameters

• idu: required(string)

  Identifiant de l'unité d'archive.

Annotations

• deprecated

  "This method is deprecated and will be removed. You should use POST on /units instead (using massUpdate)."

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• $action: (array of object)

  Contient les actions de mise à jour à appliquer

  Items:

Example:

{
  "$action": [ { "$set": { "NewField": "New value" } } ]
}

URI Parameters

• idu: required(string)

Headers

• Accept: required(one of application/octet-stream, application/json, application/zip)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

• X-Qualifier: (one of BinaryMaster, Dissemination, Thumbnail, TextContent)

  L'usage est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

• X-Version: (integer)

  La version est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• $projection: (object)

  Contient la projection à appliquer

  • $fields: (object)

Example:

{
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

URI Parameters

• idu: required(string)

Headers

• X-Http-Method-Override: required(GET)
• Accept: required(one of application/octet-stream, application/json, application/zip)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

• X-Qualifier: (one of BinaryMaster, Dissemination, Thumbnail, TextContent)

  L'usage est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

• X-Version: (integer)

  La version est utilisée et obligatoire uniquement en présence de Accept: application/octet-stream. ONLY VALID with Accept application/octet-stream

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• $projection: (object)

  Contient la projection à appliquer

  • $fields: (object)

Example:

{
  "$projection": { "$fields": { "#id": 1, "#qualifiers": 1, "#type": 1, "#parents": 1 } }
}

URI Parameters

• idu: required(string)

Headers

• Accept: required(application/json)
• Content-Type: required(application/json)
• X-Qualifier: required(one of BinaryMaster, Dissemination, Thumbnail, TextContent)

  Le qualifier de l'objet binaire

• X-Version: required(integer)

  La version de l'objet (Ex. 1, 2...)

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• queries: required(array of DslTypes.DslAtomicUpdateQuery)

  Contient la liste des requêtes de mise à jour unitaire des métadonnées

  Items: Requête DSL multiple pour le traitement de masse pour mise à jour unitaire des métadonnées

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:

    Example:

    {
      "$query": [
        {
          "$eq": {
            "myField1": "myValue"
          },
          "$depth": 4
        }
      ]
    }

  • $action: required(array of object)

    Contient les actions de mise à jour à appliquer

    Items:

    Example:

    {
      "$action": [
        {
          "$set": {
            "$myField1": "myValue"
          },
          "$unset": [
            "myField2"
          ]
        }
      ]
    }

• threshold: (integer - minimum: 1 - maximum: 100000000)

  Contient le seuil du traitement en masse unitaire en nombre de queries (optionnel)

Example:

{
  "threshold": 10000,
  "queries": [
    {
      "$query": [
        {
          "$eq": {
            "ArchivalAgencyArchiveUnitIdentifier": "Value1"
          }
        }
      ],
      "$action": [
        {
          "$set": {
            "Title": "AAAUI Value1 modifiée par le passage des TNR"
          }
        }
      ]
    },
    {
      "$query": [
        {
          "$eq": {
            "ArchivalAgencyArchiveUnitIdentifier": "Value2"
          }
        }
      ],
      "$action": [
        {
          "$setregex": {
            "$target": "Description",
            "$controlPattern": "Cette unité de description doit hériter",
            "$updatePattern": "Cette unité de description modifiée par le passage des TNR doit hériter"
          }
        },
        {
          "$set": {
            "Description": "Cette unité de description a été modifiée par le passage des TNR"
          }
        }
      ]
    }
  ]
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

• Accept: required(one of application/json, application/zip, application/octet-stream)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

• $roots: required(array of string)

  Contient les racines de la recherche

• $query: required(array of object)

  Contient plusieurs requêtes

  Items:
• $filter: (object)

  Contient les filtres à appliquer

  • $offset: (integer - minimum: 1 - maximum: 100000)
  • $limit: (integer - minimum: 1 - maximum: 100000)
  • $orderby: (object)
• $projection: required(object)

  Contient la projection à appliquer

  • $fields: (object)
• $facet: (array of DslTypes.Facet)

  Contains facet if requested

  Items: Facet

  • $name: required(string)
  • $terms: (object)
    • $field: required(string)

      Example:

      #qualifiers.versions.FormatIdentification.MimeType

    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $size: required(number)

      Example:

      20

    • $order: required(string)

      Example:

      ASC

  • $filters: (object)
    • $query_filters: required(array of object)

      Items: items

      • $name: required(string)
      • $query: required(object)
  • $date_range: (object)
    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $field: required(string)

      Example:

      #qualifiers.versions.FileInfo.LastModified

    • $format: required(string)

      Example:

      YYYY

    • $ranges: required(array of object - minItems: 1 - maxItems: 2)

      Items: items

      • $from: required(string)

        Example:

        2017

      • $to: required(string)

        Example:

        2020

Example:

{
  "$roots": [
    "id0"
  ],
  "$query": [
    {
      "$match": {
        "title": "titre"
      },
      "$depth": 4
    }
  ],
  "$filter": {
    "$limit": 1000,
    "$offset": 10
  },
  "$projection": {
    "$fields": {
      "#id": 1,
      "title": 1,
      "#type": 1,
      "#sector": 1,
      "#parents": 1,
      "#object": 1
    }
  }
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

• Accept: required(one of application/json, application/zip, application/octet-stream)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

• $roots: required(array of string)

  Contient les racines de la recherche

• $query: required(array of object)

  Contient plusieurs requêtes

  Items:
• $filter: (object)

  Contient les filtres à appliquer

  • $offset: (integer - minimum: 1 - maximum: 100000)
  • $limit: (integer - minimum: 1 - maximum: 100000)
  • $orderby: (object)
  • $track_total_hits: (boolean)

    Devrait être setté à "true", au niveau de la configuration, pour avoir une précision sur les résultats de recherche dépassant 10k données (par défaut "false").

• $projection: required(object)

  Contient la projection à appliquer

  • $fields: (object)
• $facet: (array of DslTypes.Facet)

  Contains facet if requested

  Items: Facet

  • $name: required(string)
  • $terms: (object)
    • $field: required(string)

      Example:

      #qualifiers.versions.FormatIdentification.MimeType

    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $size: required(number)

      Example:

      20

    • $order: required(string)

      Example:

      ASC

  • $filters: (object)
    • $query_filters: required(array of object)

      Items: items

      • $name: required(string)
      • $query: required(object)
  • $date_range: (object)
    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $field: required(string)

      Example:

      #qualifiers.versions.FileInfo.LastModified

    • $format: required(string)

      Example:

      YYYY

    • $ranges: required(array of object - minItems: 1 - maxItems: 2)

      Items: items

      • $from: required(string)

        Example:

        2017

      • $to: required(string)

        Example:

        2020

Example:

{
 "$query": [
   {
     "$and": [
       {
     "$match": {
       "FileInfo.FileName": "FileName.txt"
     }
       },
       {
     "$subobject": {
       "#qualifiers.versions": {
         "$and": [
           {
         "$eq": {
           "#qualifiers.versions.FormatIdentification.MimeType": "text/plain"
         }
           },
           {
         "$lte": {
           "#qualifiers.versions.Size": 20000
         }
           }
         ]
       }
     }
       }
     ]
   }
 ],
 "$projection": {},
 "$filter": {}
}

Headers

• X-Http-Method-Override: required(GET)
• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

• Accept: required(one of application/json, application/zip, application/octet-stream)

  Allow to specify if a result must contain only Metadata ('application/json') or only the Objects with a binary content ('application/octet-stream').

Body

Media type: application/json

Type: object

• $roots: required(array of string)

  Contient les racines de la recherche

• $query: required(array of object)

  Contient plusieurs requêtes

  Items:
• $filter: (object)

  Contient les filtres à appliquer

  • $offset: (integer - minimum: 1 - maximum: 100000)
  • $limit: (integer - minimum: 1 - maximum: 100000)
  • $orderby: (object)
  • $track_total_hits: (boolean)

    Devrait être setté à "true", au niveau de la configuration, pour avoir une précision sur les résultats de recherche dépassant 10k données (par défaut "false").

• $projection: required(object)

  Contient la projection à appliquer

  • $fields: (object)
• $facet: (array of DslTypes.Facet)

  Contains facet if requested

  Items: Facet

  • $name: required(string)
  • $terms: (object)
    • $field: required(string)

      Example:

      #qualifiers.versions.FormatIdentification.MimeType

    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $size: required(number)

      Example:

      20

    • $order: required(string)

      Example:

      ASC

  • $filters: (object)
    • $query_filters: required(array of object)

      Items: items

      • $name: required(string)
      • $query: required(object)
  • $date_range: (object)
    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $field: required(string)

      Example:

      #qualifiers.versions.FileInfo.LastModified

    • $format: required(string)

      Example:

      YYYY

    • $ranges: required(array of object - minItems: 1 - maxItems: 2)

      Items: items

      • $from: required(string)

        Example:

        2017

      • $to: required(string)

        Example:

        2020

Example:

{
 "$query": [
   {
     "$and": [
       {
     "$match": {
       "FileInfo.FileName": "FileName.txt"
     }
       },
       {
     "$subobject": {
       "#qualifiers.versions": {
         "$and": [
           {
         "$eq": {
           "#qualifiers.versions.FormatIdentification.MimeType": "text/plain"
         }
           },
           {
         "$lte": {
           "#qualifiers.versions.Size": 20000
         }
           }
         ]
       }
     }
       }
     ]
   }
 ],
 "$projection": {},
 "$filter": {}
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• force: required(boolean)

  true si on force la restauration, false sinon

  Example:

  false

• dslRequest: required(object)

  requete DSL pour filtrer les units à restaurer

  • $roots: required(array of string)

    Contient les racines de la recherche

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:
  • $threshold: (integer - minimum: 1 - maximum: 100000000)

    Contient le seuil du traitement de masse (optionnel)

  • $filter: (object)
    • $offset: (integer - minimum: 1 - maximum: 100000)
    • $limit: (integer - minimum: 1 - maximum: 100000)
    • $orderby: (object)
  • $projection: (object)
    • $fields: (object)

  Example:

  {
    "$roots": [
      "guid1",
      "guid2"
    ],
    "$query": [
      {
        "$eq": {
          "myField1": "myValue"
        },
        "$depth": 4
      }
    ],
    "$threshold": 1000
  }

• operationId: required(string)

  identifiant de l'opération à restaurer

• $fields: required(array of )

  les champs à restaurer

Example:

{
  "force": false,
  "dslRequest": {
    "$roots": [],
    "$query": []
  },
  "operationId": "aeeaaaaaachikhnoaant6alwd2ltg6iaaaaq",
  "$fields": ["Title"]
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• $roots: required(array of string)

  Contient les racines de la recherche

• $query: required(array of object)

  Contient plusieurs requêtes

  Items:
• $filter: (object)

  Contient les filtres à appliquer

  • $offset: (integer - minimum: 1 - maximum: 100000)
  • $limit: (integer - minimum: 1 - maximum: 100000)
  • $orderby: (object)
• $projection: required(object)

  Contient la projection à appliquer

  • $fields: (object)
• $facet: (array of DslTypes.Facet)

  Contains facet if requested

  Items: Facet

  • $name: required(string)
  • $terms: (object)
    • $field: required(string)

      Example:

      #qualifiers.versions.FormatIdentification.MimeType

    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $size: required(number)

      Example:

      20

    • $order: required(string)

      Example:

      ASC

  • $filters: (object)
    • $query_filters: required(array of object)

      Items: items

      • $name: required(string)
      • $query: required(object)
  • $date_range: (object)
    • $subobject: required(string)

      Example:

      #qualifiers.versions

    • $field: required(string)

      Example:

      #qualifiers.versions.FileInfo.LastModified

    • $format: required(string)

      Example:

      YYYY

    • $ranges: required(array of object - minItems: 1 - maxItems: 2)

      Items: items

      • $from: required(string)

        Example:

        2017

      • $to: required(string)

        Example:

        2020

Example:

{
  "$roots": [
    "id0"
  ],
  "$query": [
    {
      "$match": {
        "title": "titre"
      },
      "$depth": 4
    }
  ],
  "$filter": {
    "$limit": 1000,
    "$offset": 10
  },
  "$projection": {
    "$fields": {
      "#id": 1,
      "title": 1,
      "#type": 1,
      "#sector": 1,
      "#parents": 1,
      "#object": 1
    }
  }
}

URI Parameters

• id: required(string)

  Identifiant de l'opération d'export DIP.

Headers

• Accept: required(application/octet-stream)

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• dipExportType: required(one of MINIMAL, FULL)

  Le type d'export DIP

• exportWithLogBookLFC: (boolean)

  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets

• transferWithLogBookLFC: (boolean)

  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le transfert

• dslRequest: required(object)

  Contient la requête de recherche

  • $roots: required(array of string)

    Contient les racines de la recherche

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:
  • $filter: (object)

    Contient les filtres à appliquer

    • $offset: (integer - minimum: 1 - maximum: 100000)
    • $limit: (integer - minimum: 1 - maximum: 100000)
    • $orderby: (object)
  • $projection: required(object)

    Contient la projection à appliquer

    • $fields: (object)
  • $facet: (array of DslTypes.Facet)

    Contains facet if requested

    Items: Facet

    • $name: required(string)
    • $terms: (object)
      • $field: required(string)

        Example:

        #qualifiers.versions.FormatIdentification.MimeType

      • $subobject: required(string)

        Example:

        #qualifiers.versions

      • $size: required(number)

        Example:

        20

      • $order: required(string)

        Example:

        ASC

    • $filters: (object)
      • $query_filters: required(array of object)

        Items: items

        • $name: required(string)
        • $query: required(object)
    • $date_range: (object)
      • $subobject: required(string)

        Example:

        #qualifiers.versions

      • $field: required(string)

        Example:

        #qualifiers.versions.FileInfo.LastModified

      • $format: required(string)

        Example:

        YYYY

      • $ranges: required(array of object - minItems: 1 - maxItems: 2)

        Items: items

        • $from: required(string)

          Example:

          2017

        • $to: required(string)

          Example:

          2020

  Example:

  {
    "$roots": [
      "guid1",
      "guid2"
    ],
    "$query": [
      {
        "$eq": {
          "myField1": "myValue"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 100,
      "$offset": 50
    },
    "$projection": {
      "$fields": {
        "myField1": 1,
        "myField2.mySubField": 1
      }
    }
  }

• dataObjectVersionToExport: (object)

  L'identifiant du scénario de préservation

  • dataObjectVersions: required(array of string)

    Liste des versions d'objets à inclure dans l'export

• dipRequestParameters: (object)

  Les paramètres nécessaires pour faire un export DIP, ce champs est obligatoire quand le dipExportType est FULL

  • archivalAgreement: (string)

    Contrat d'entrée

  • originatingAgencyIdentifier: (string)

    Identifiant du service producteur

  • comment: (string)

    Intitulé

  • submissionAgencyIdentifier: (string)

    Identifiant du service versant

  • archivalAgencyIdentifier: required(string)

    Identifiant du service d'archives. Si Vitam trouve un seul service d'archives pour la selection d'unités archivistiques, ce service sera utilisé par défaut.

  • messageRequestIdentifier: required(string)

    Identifiant de la demande

  • requesterIdentifier: required(string)

    Identifiant du demandeur

  • authorizationRequestReplyIdentifier: (string)

    Identifiant de la réponse à une demande d'autorisation

• maxSizeThreshold: (integer)

  Le seuil du poids binaire max autorisé pour un DIP ou un SIP de transfert

• sedaVersion: (string)

  La version SEDA d'export de DIP ou d'un SIP de transfert ( 2.2 par défaut )

Example:

{
  "dipExportType": "FULL",
  "dataObjectVersionToExport": {
    "dataObjectVersions": [
      "BinaryMaster"
    ]
  },
  "transferWithLogBookLFC": true,
  "dipRequestParameters": {
    "archivalAgreement": "ArchivalAgreement",
    "originatingAgencyIdentifier": "OriginatingAgencyIdentifier",
    "comment": "Comment",
    "submissionAgencyIdentifier": "SubmissionAgencyIdentifier",
    "messageRequestIdentifier": "MessageRequestIdentifier",
    "authorizationRequestReplyIdentifier": "AuthorizationRequestReplyIdentifier",
    "archivalAgencyIdentifier": "ArchivalAgencyIdentifier",
    "requesterIdentifier": "RequesterIdentifier"
  },
  "dslRequest": {
    "$roots": [
      "id0"
    ],
    "$query": [
      {
        "$match": {
          "title": "titre"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 1000,
      "$offset": 10
    },
    "$projection": {
      "$fields": {
        "#id": 1,
        "title": 1,
        "#type": 1,
        "#sector": 1,
        "#parents": 1,
        "#object": 1
      }
    }
  },
  "maxSizeThreshold": 1024,
  "sedaVersion": "2.2"
}

Headers

• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• exportWithLogBookLFC: (boolean)

  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le DIP

• transferWithLogBookLFC: (boolean)

  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le transfert

• dslRequest: required(object)

  Contient la requête de recherche

  • $roots: required(array of string)

    Contient les racines de la recherche

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:
  • $filter: (object)

    Contient les filtres à appliquer

    • $offset: (integer - minimum: 1 - maximum: 100000)
    • $limit: (integer - minimum: 1 - maximum: 100000)
    • $orderby: (object)
  • $projection: required(object)

    Contient la projection à appliquer

    • $fields: (object)
  • $facet: (array of DslTypes.Facet)

    Contains facet if requested

    Items: Facet

    • $name: required(string)
    • $terms: (object)
      • $field: required(string)

        Example:

        #qualifiers.versions.FormatIdentification.MimeType

      • $subobject: required(string)

        Example:

        #qualifiers.versions

      • $size: required(number)

        Example:

        20

      • $order: required(string)

        Example:

        ASC

    • $filters: (object)
      • $query_filters: required(array of object)

        Items: items

        • $name: required(string)
        • $query: required(object)
    • $date_range: (object)
      • $subobject: required(string)

        Example:

        #qualifiers.versions

      • $field: required(string)

        Example:

        #qualifiers.versions.FileInfo.LastModified

      • $format: required(string)

        Example:

        YYYY

      • $ranges: required(array of object - minItems: 1 - maxItems: 2)

        Items: items

        • $from: required(string)

          Example:

          2017

        • $to: required(string)

          Example:

          2020

  Example:

  {
    "$roots": [
      "guid1",
      "guid2"
    ],
    "$query": [
      {
        "$eq": {
          "myField1": "myValue"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 100,
      "$offset": 50
    },
    "$projection": {
      "$fields": {
        "myField1": 1,
        "myField2.mySubField": 1
      }
    }
  }

• maxSizeThreshold: (integer)

  Le seuil du poids binaire max autorisé pour un DIP ou un SIP de transfert

• dataObjectVersionToExport: (object)

  L'identifiant du scénario de préservation

  • dataObjectVersions: required(array of string)

    Liste des versions d'objets à inclure dans l'export

• transferRequestParameters: required(object)

  Les paramètres nécessaires pour faire un transfert d'unités archivistiques

  • archivalAgreement: required(string)

    Contrat d'entrée

  • originatingAgencyIdentifier: required(string)

    Identifiant du service producteur

  • archivalAgencyIdentifier: required(string)

    Identifiant du service d'archives

  • comment: (string)

    Intitulé

  • submissionAgencyIdentifier: (string)

    Identifiant du service versant

  • transferringAgency: (string)

    Service versant

  • transferRequestReplyIdentifier: (string)

    Identifiant de la réponse à une demande de transfert

  • relatedTransferReference: (array of string)

    Référence à un transfert d'archives lié

• sedaVersion: (string)

  La version SEDA d'export de DIP ou d'un SIP de transfert ( 2.2 par défaut )

Example:

{
  "dataObjectVersionToExport": {
    "dataObjectVersions": [
      "BinaryMaster"
    ]
  },
  "transferWithLogBookLFC": true,
  "transferRequestParameters": {
    "archivalAgreement": "ArchivalAgreement",
    "originatingAgencyIdentifier": "OriginatingAgencyIdentifier",
    "comment": "Comment",
    "submissionAgencyIdentifier": "SubmissionAgencyIdentifier",
    "relatedTransferReference": [
      "RelatedTransferReference"
    ],
    "transferRequestReplyIdentifier": "TransferRequestReplyIdentifier",
    "archivalAgencyIdentifier": "ArchivalAgencyIdentifier",
    "transferringAgency": "TransferringAgency"
  },
  "dslRequest": {
    "$roots": [
      "id0"
    ],
    "$query": [
      {
        "$match": {
          "title": "titre"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 1000,
      "$offset": 10
    },
    "$projection": {
      "$fields": {
        "#id": 1,
        "title": 1,
        "#type": 1,
        "#sector": 1,
        "#parents": 1,
        "#object": 1
      }
    }
  },
  "maxSizeThreshold": 1024,
  "sedaVersion": "2.2"
}

URI Parameters

• id: required(string)

  Identifiant de l'opération du transfert d'archives.

Headers

• Accept: required(application/octet-stream)

Headers

• Accept: required(application/json)
• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• dslRequest: required(object)

  Contient la requête de recherche

  • $roots: required(array of string)

    Contient les racines de la recherche

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:
  • $threshold: (integer - minimum: 1 - maximum: 100000000)

    Contient le seuil du traitement de masse (optionnel)

  • $filter: (object)
    • $offset: (integer - minimum: 1 - maximum: 100000)
    • $limit: (integer - minimum: 1 - maximum: 100000)
    • $orderby: (object)
  • $projection: (object)
    • $fields: (object)

  Example:

  {
    "$roots": [
      "guid1",
      "guid2"
    ],
    "$query": [
      {
        "$eq": {
          "myField1": "myValue"
        },
        "$depth": 4
      }
    ],
    "$threshold": 1000
  }

• date: required(string)

  La date d'élimination

Example:

{
  "dslRequest": {
    "$roots": [ "id0" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}

Headers

• Accept: required(application/json)
• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• dslRequest: required(object)

  Contient la requête de recherche

  • $roots: required(array of string)

    Contient les racines de la recherche

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:
  • $threshold: (integer - minimum: 1 - maximum: 100000000)

    Contient le seuil du traitement de masse (optionnel)

  • $filter: (object)
    • $offset: (integer - minimum: 1 - maximum: 100000)
    • $limit: (integer - minimum: 1 - maximum: 100000)
    • $orderby: (object)
  • $projection: (object)
    • $fields: (object)

  Example:

  {
    "$roots": [
      "guid1",
      "guid2"
    ],
    "$query": [
      {
        "$eq": {
          "myField1": "myValue"
        },
        "$depth": 4
      }
    ],
    "$threshold": 1000
  }

• date: required(string)

  La date d'élimination

Example:

{
  "dslRequest": {
    "$roots": [ "id0" ],
    "$query": [
      {
        "$match": { "title": "titre" },
        "$depth": 4
      }
    ],
    "$threshold": 10000
  },
  "date": "2018-01-23"
}

Headers

• Accept: required(application/json)
• Content-Type: required(application/json)
• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

Body

Media type: application/json

Type: object

• StartDate: (string)

  Date de début des fichiers de log (un fichier de log contenant des logs après et avant cette date est remonté au complet)

  Example:

  2018-11-14

• EndDate: (string)

  Date de fin des fichiers de log (un fichier de log contenant des logs après et avant cette date est remonté au complet)

  Example:

  2018-11-14

Example:

{
  "StartDate": "2018-11-14"
}

Headers

• Accept: required(application/json)
• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• dslQuery: required(object)

  Contient la requête de recherche

  • $roots: required(array of string)

    Contient les racines de la recherche

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:
  • $threshold: (integer - minimum: 1 - maximum: 100000000)

    Contient le seuil du traitement de masse (optionnel)

  • $filter: (object)
    • $offset: (integer - minimum: 1 - maximum: 100000)
    • $limit: (integer - minimum: 1 - maximum: 100000)
    • $orderby: (object)
  • $projection: (object)
    • $fields: (object)

  Example:

  {
    "$roots": [
      "guid1",
      "guid2"
    ],
    "$query": [
      {
        "$eq": {
          "myField1": "myValue"
        },
        "$depth": 4
      }
    ],
    "$threshold": 1000
  }

• scenarioId: required(string)

  L'identifiant du scénario de préservation

• targetUsage: required(string)

  usage du binaire générer

• sourceUsage: required(string)

  usage du binaire cible

• version: required(string)

  La version du binaire sur lequel on veux opérer une action de préservation

Example:

{
  "dslQuery" : {
    "$roots": [],
    "$query": [
      {
        "$eq": {
          "#id": "aeaqaaaaaaezyoa6abacealifcom6xyaaaaq"
        }
      }
    ],
    "$threshold": 40,
    "$filter": {},
    "$projection": {}
  },
  "scenarioId" : "PSC-000001",
  "targetUsage": "BinaryMaster",
  "sourceUsage": "Dissemination",
  "version": "FIRST"
}

Headers

• Accept: required(application/xml)
• Content-Type: required(application/json)
• X-Application-Id: (string)

  Session Identifier from client Front-Office Application

  Example:

  SESSION-ID-00001

• X-Personal-Certificate: (string)

  Personal certificate (in Base64-encoded DER format), required only if this resource needs personal authentification. If the resource requires personal authentication, and no personal certificate has been provided OR the provided personal certificate is unauthorized, the server will return a 401 http status.

  Example:

  MIIGfzCCBGegAwIBAgICAPcwDQYJK...

• X-Tenant-Id: required(number)

  Unique Tenant Identifier.

  Example:

  0

• X-Access-Contract-Id: required(string)

  Unique Access Contract Identifier. Allow read/write access on specific archive unit.

  Example:

  Access-Contract-00001

Body

Media type: application/json

Type: object

• exportWithLogBookLFC: (boolean)

  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le DIP

• transferWithLogBookLFC: (boolean)

  True pour inclure les logbook de cycle de vie des unités archivistiques et groupes d'objets pour le transfert

• dslRequest: required(object)

  Contient la requête de recherche

  • $roots: required(array of string)

    Contient les racines de la recherche

  • $query: required(array of object)

    Contient plusieurs requêtes

    Items:
  • $filter: (object)

    Contient les filtres à appliquer

    • $offset: (integer - minimum: 1 - maximum: 100000)
    • $limit: (integer - minimum: 1 - maximum: 100000)
    • $orderby: (object)
  • $projection: required(object)

    Contient la projection à appliquer

    • $fields: (object)
  • $facet: (array of DslTypes.Facet)

    Contains facet if requested

    Items: Facet

    • $name: required(string)
    • $terms: (object)
      • $field: required(string)

        Example:

        #qualifiers.versions.FormatIdentification.MimeType

      • $subobject: required(string)

        Example:

        #qualifiers.versions

      • $size: required(number)

        Example:

        20

      • $order: required(string)

        Example:

        ASC

    • $filters: (object)
      • $query_filters: required(array of object)

        Items: items

        • $name: required(string)
        • $query: required(object)
    • $date_range: (object)
      • $subobject: required(string)

        Example:

        #qualifiers.versions

      • $field: required(string)

        Example:

        #qualifiers.versions.FileInfo.LastModified

      • $format: required(string)

        Example:

        YYYY

      • $ranges: required(array of object - minItems: 1 - maxItems: 2)

        Items: items

        • $from: required(string)

          Example:

          2017

        • $to: required(string)

          Example:

          2020

  Example:

  {
    "$roots": [
      "guid1",
      "guid2"
    ],
    "$query": [
      {
        "$eq": {
          "myField1": "myValue"
        },
        "$depth": 4
      }
    ],
    "$filter": {
      "$limit": 100,
      "$offset": 50
    },
    "$projection": {
      "$fields": {
        "myField1": 1,
        "myField2.mySubField": 1
      }
    }
  }

• maxSizeThreshold: (integer)

  Le seuil du poids binaire max autorisé pour un DIP ou un SIP de transfert

• dataObjectVersionToExport: (object)

  L'identifiant du scénario de préservation

  • dataObjectVersions: required(array of string)

    Liste des versions d'objets à inclure dans l'export

• transferRequestParameters: required(object)

  Les paramètres nécessaires pour faire un transfert d'unités archivistiques

  • archivalAgreement: required(string)

    Contrat d'entrée

  • originatingAgencyIdentifier: required(string)

    Identifiant du service producteur

  • archivalAgencyIdentifier: required(string)

    Identifiant du service d'archives

  • comment: (string)

    Intitulé

  • submissionAgencyIdentifier: (string)

    Identifiant du service versant

  • transferringAgency: (string)

    Service versant

  • transferRequestReplyIdentifier: (string)

    Identifiant de la réponse à une demande de transfert

  • relatedTransferReference: (array of string)

    Référence à un transfert d'archives lié

• sedaVersion: (string)

  La version SEDA d'export de DIP ou d'un SIP de transfert ( 2.2 par défaut )