1. Vue générale

This API is used by the Archive UI to send archives to external Vitam UI layers and than to Vitam. This API should be used by the Archive UI only.

1.2. Information de contact

Contact : Direction de la diffusion et des partenariats
Email de contact : contact@programmevitam.fr

1.3. Information de licence

Licence : License to be defined …​
Licence URL : URL not defined.
Conditions de service : Terms of service

1.4. Schéma d’URI

Serveur : localhost
Chemin de base : /

1.5. Tags

  • archives Search : Access Contract Temp Controller

  • searchcriteriahistory : Search Criteria History Controller

1.6. Produit

  • application/json

2. Ressources

2.1. Archives Search

Access Contract Temp Controller

2.1.1. Get entity

GET /archive-search-api/archive-search/accesscontracts
Paramètres
Type Nom Description Schéma

Query

criteria
optionnel

criteria

string

Réponses
Code HTTP Description Schéma

200

OK

< AccessContractDto > array

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/accesscontracts
Requête query
{
  "criteria" : "string"
}
Exemple de réponse HTTP
Réponse 200
[ {
  "accessLog" : "string",
  "activationDate" : "string",
  "creationDate" : "string",
  "dataObjectVersion" : [ "string" ],
  "description" : "string",
  "everyDataObjectVersion" : true,
  "everyOriginatingAgency" : true,
  "excludedRootUnits" : [ "string" ],
  "id" : "string",
  "identifier" : "string",
  "lastUpdate" : "string",
  "name" : "string",
  "originatingAgencies" : [ "string" ],
  "rootUnits" : [ "string" ],
  "ruleCategoryToFilter" : [ "string" ],
  "status" : "string",
  "tenant" : 0,
  "version" : 0,
  "writingPermission" : true,
  "writingRestrictedDesc" : true
} ]

2.1.2. Find the Archive Unit Details

GET /archive-search-api/archive-search/archiveunit/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

ResultsDto

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/archiveunit/string
Exemple de réponse HTTP
Réponse 200
{
  "#allunitups" : [ "string" ],
  "#id" : "string",
  "#management" : {
    "AppraisalRule" : {
      "FinalAction" : "string",
      "Rules" : [ {
        "EndDate" : "string",
        "Rule" : "string",
        "StartDate" : "string"
      } ]
    }
  },
  "#max" : 0,
  "#min" : 0,
  "#nbobjects" : 0,
  "#nbunits" : 0,
  "#object" : "string",
  "#operations" : [ "string" ],
  "#opi" : "string",
  "#originating_agencies" : [ "string" ],
  "#originating_agency" : "string",
  "#qualifiers" : [ {
    "qualifier" : "string",
    "versions" : [ {
      "#id" : "string",
      "#rank" : 0,
      "#storage" : {
        "#nbc" : "string",
        "offerIds" : [ "string" ],
        "strategyId" : "string"
      },
      "Algorithm" : "string",
      "DataObjectGroupId" : "string",
      "DataObjectVersion" : "string",
      "FileInfo" : {
        "CreatingApplicationName" : "string",
        "CreatingApplicationVersion" : "string",
        "CreatingOs" : "string",
        "CreatingOsVersion" : "string",
        "DateCreatedByApplication" : "string",
        "Filename" : "string",
        "LastModified" : "string"
      },
      "FormatIdentification" : {
        "Encoding" : "string",
        "FormatId" : "string",
        "FormatLitteral" : "string",
        "MimeType" : "string"
      },
      "MessageDigest" : "string",
      "Metadata" : {
        "Audio" : "object",
        "Document" : "object",
        "Image" : "object",
        "Text" : "object",
        "Video" : "object"
      },
      "OtherMetadata" : "object",
      "PhysicalDimensions" : {
        "Depth" : {
          "dValue" : 0.0,
          "dvalue" : 0.0,
          "unit" : "string"
        },
        "Diameter" : {
          "dValue" : 0.0,
          "dvalue" : 0.0,
          "unit" : "string"
        },
        "Height" : {
          "dValue" : 0.0,
          "dvalue" : 0.0,
          "unit" : "string"
        },
        "Length" : {
          "dValue" : 0.0,
          "dvalue" : 0.0,
          "unit" : "string"
        },
        "NumberOfPage" : 0,
        "Shape" : "string",
        "Thickness" : {
          "dValue" : 0.0,
          "dvalue" : 0.0,
          "unit" : "string"
        },
        "Weight" : {
          "dValue" : 0.0,
          "dvalue" : 0.0,
          "unit" : "string"
        },
        "Width" : {
          "dValue" : 0.0,
          "dvalue" : 0.0,
          "unit" : "string"
        },
        "any" : [ "object" ]
      },
      "PhysicalId" : "string",
      "Size" : 0,
      "Uri" : "string"
    } ]
  } ],
  "#storage" : {
    "strategyId" : "string"
  },
  "#tenant" : 0,
  "#unitType" : "string",
  "#unitups" : [ "string" ],
  "AcquiredDate" : "string",
  "CreatedDate" : "string",
  "Description" : "string",
  "DescriptionLevel" : "string",
  "DocumentType" : "string",
  "EndDate" : "string",
  "FileInfo" : {
    "CreatingApplicationName" : "string",
    "CreatingApplicationVersion" : "string",
    "CreatingOs" : "string",
    "CreatingOsVersion" : "string",
    "DateCreatedByApplication" : "string",
    "Filename" : "string",
    "LastModified" : "string"
  },
  "InheritedRules" : {
    "AppraisalRule" : {
      "Properties" : [ {
        "PropertyName" : "string",
        "PropertyValue" : "object"
      } ],
      "Rules" : [ {
        "EndDate" : "string",
        "Rule" : "string",
        "StartDate" : "string"
      } ]
    }
  },
  "Keyword" : [ {
    "KeywordContent" : "string",
    "KeywordReference" : "string"
  } ],
  "OriginatingAgencyArchiveUnitIdentifier" : [ "string" ],
  "OriginatingSystemId" : [ "string" ],
  "PhysicalAgency" : [ "string" ],
  "PhysicalStatus" : [ "string" ],
  "PhysicalType" : [ "string" ],
  "ReceivedDate" : "string",
  "RegisteredDate" : "string",
  "SentDate" : "string",
  "StartDate" : "string",
  "Status" : "string",
  "SubmissionAgency" : {
    "Identifier" : "string"
  },
  "Title" : "string",
  "Title_" : {
    "en" : "string",
    "fr" : "string"
  },
  "TransactedDate" : "string",
  "Version" : "string",
  "Vtag" : [ {
    "Key" : [ "string" ],
    "Value" : [ "string" ]
  } ],
  "Xtag" : [ {
    "Key" : [ "string" ],
    "Value" : [ "string" ]
  } ]
}

2.1.3. Download Object from the Archive Unit

GET /archive-search-api/archive-search/downloadobjectfromunit/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Resource

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/downloadobjectfromunit/string
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.1.4. export into csv format archive units by criteria

POST /archive-search-api/archive-search/export-csv-search
Paramètres
Type Nom Description Schéma

Body

searchQuery
requis

searchQuery

SearchCriteriaDto

Réponses
Code HTTP Description Schéma

200

OK

Resource

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/export-csv-search
Requête body
{
  "criteriaList" : [ {
    "criteria" : "string",
    "values" : [ "string" ]
  } ],
  "fieldsList" : [ "string" ],
  "language" : "string",
  "nodes" : [ "string" ],
  "pageNumber" : 0,
  "size" : 0,
  "sortingCriteria" : {
    "criteria" : "string",
    "sorting" : "string"
  }
}
Exemple de réponse HTTP
Réponse 200
{
  "description" : "string",
  "file" : "file",
  "filename" : "string",
  "inputStream" : { },
  "open" : true,
  "readable" : true,
  "uri" : "string",
  "url" : "string"
}

2.1.5. Get filing plan

GET /archive-search-api/archive-search/filingholdingscheme
Réponses
Code HTTP Description Schéma

200

OK

VitamUISearchResponseDto

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/filingholdingscheme
Exemple de réponse HTTP
Réponse 200
{
  "$context" : {
    "$filter" : {
      "$limit" : 0,
      "$orderby" : {
        "TransactedDate" : 0
      }
    },
    "$projection" : {
      "$fields" : {
        "Description" : 0,
        "Title" : 0
      }
    },
    "$query" : [ {
      "$filter" : {
        "$limit" : 0,
        "$offset" : 0,
        "$orderby" : {
          "string" : 0
        }
      },
      "$projection" : {
        "$fields" : {
          "string" : 0
        }
      },
      "$query" : [ { } ],
      "$roots" : [ "string" ]
    } ],
    "$roots" : [ "string" ]
  },
  "$facetResults" : [ {
    "buckets" : [ {
      "count" : 0,
      "value" : "string"
    } ],
    "name" : "string"
  } ],
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "#allunitups" : [ "string" ],
    "#id" : "string",
    "#management" : {
      "AppraisalRule" : {
        "FinalAction" : "string",
        "Rules" : [ {
          "EndDate" : "string",
          "Rule" : "string",
          "StartDate" : "string"
        } ]
      }
    },
    "#max" : 0,
    "#min" : 0,
    "#nbobjects" : 0,
    "#nbunits" : 0,
    "#object" : "string",
    "#operations" : [ "string" ],
    "#opi" : "string",
    "#originating_agencies" : [ "string" ],
    "#originating_agency" : "string",
    "#qualifiers" : [ {
      "qualifier" : "string",
      "versions" : [ {
        "#id" : "string",
        "#rank" : 0,
        "#storage" : {
          "#nbc" : "string",
          "offerIds" : [ "string" ],
          "strategyId" : "string"
        },
        "Algorithm" : "string",
        "DataObjectGroupId" : "string",
        "DataObjectVersion" : "string",
        "FileInfo" : {
          "CreatingApplicationName" : "string",
          "CreatingApplicationVersion" : "string",
          "CreatingOs" : "string",
          "CreatingOsVersion" : "string",
          "DateCreatedByApplication" : "string",
          "Filename" : "string",
          "LastModified" : "string"
        },
        "FormatIdentification" : {
          "Encoding" : "string",
          "FormatId" : "string",
          "FormatLitteral" : "string",
          "MimeType" : "string"
        },
        "MessageDigest" : "string",
        "Metadata" : {
          "Audio" : "object",
          "Document" : "object",
          "Image" : "object",
          "Text" : "object",
          "Video" : "object"
        },
        "OtherMetadata" : "object",
        "PhysicalDimensions" : {
          "Depth" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Diameter" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Height" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Length" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "NumberOfPage" : 0,
          "Shape" : "string",
          "Thickness" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Weight" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Width" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "any" : [ "object" ]
        },
        "PhysicalId" : "string",
        "Size" : 0,
        "Uri" : "string"
      } ]
    } ],
    "#storage" : {
      "strategyId" : "string"
    },
    "#tenant" : 0,
    "#unitType" : "string",
    "#unitups" : [ "string" ],
    "AcquiredDate" : "string",
    "CreatedDate" : "string",
    "Description" : "string",
    "DescriptionLevel" : "string",
    "DocumentType" : "string",
    "EndDate" : "string",
    "FileInfo" : {
      "CreatingApplicationName" : "string",
      "CreatingApplicationVersion" : "string",
      "CreatingOs" : "string",
      "CreatingOsVersion" : "string",
      "DateCreatedByApplication" : "string",
      "Filename" : "string",
      "LastModified" : "string"
    },
    "InheritedRules" : {
      "AppraisalRule" : {
        "Properties" : [ {
          "PropertyName" : "string",
          "PropertyValue" : "object"
        } ],
        "Rules" : [ {
          "EndDate" : "string",
          "Rule" : "string",
          "StartDate" : "string"
        } ]
      }
    },
    "Keyword" : [ {
      "KeywordContent" : "string",
      "KeywordReference" : "string"
    } ],
    "OriginatingAgencyArchiveUnitIdentifier" : [ "string" ],
    "OriginatingSystemId" : [ "string" ],
    "PhysicalAgency" : [ "string" ],
    "PhysicalStatus" : [ "string" ],
    "PhysicalType" : [ "string" ],
    "ReceivedDate" : "string",
    "RegisteredDate" : "string",
    "SentDate" : "string",
    "StartDate" : "string",
    "Status" : "string",
    "SubmissionAgency" : {
      "Identifier" : "string"
    },
    "Title" : "string",
    "Title_" : {
      "en" : "string",
      "fr" : "string"
    },
    "TransactedDate" : "string",
    "Version" : "string",
    "Vtag" : [ {
      "Key" : [ "string" ],
      "Value" : [ "string" ]
    } ],
    "Xtag" : [ {
      "Key" : [ "string" ],
      "Value" : [ "string" ]
    } ]
  } ]
}

2.1.6. find archive units by criteria

POST /archive-search-api/archive-search/search
Paramètres
Type Nom Description Schéma

Body

searchQuery
requis

searchQuery

SearchCriteriaDto

Réponses
Code HTTP Description Schéma

200

OK

VitamUIArchiveUnitResponseDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/search
Requête body
{
  "criteriaList" : [ {
    "criteria" : "string",
    "values" : [ "string" ]
  } ],
  "fieldsList" : [ "string" ],
  "language" : "string",
  "nodes" : [ "string" ],
  "pageNumber" : 0,
  "size" : 0,
  "sortingCriteria" : {
    "criteria" : "string",
    "sorting" : "string"
  }
}
Exemple de réponse HTTP
Réponse 200
{
  "$context" : {
    "$filter" : {
      "$limit" : 0,
      "$orderby" : {
        "TransactedDate" : 0
      }
    },
    "$projection" : {
      "$fields" : {
        "Description" : 0,
        "Title" : 0
      }
    },
    "$query" : [ {
      "$filter" : {
        "$limit" : 0,
        "$offset" : 0,
        "$orderby" : {
          "string" : 0
        }
      },
      "$projection" : {
        "$fields" : {
          "string" : 0
        }
      },
      "$query" : [ { } ],
      "$roots" : [ "string" ]
    } ],
    "$roots" : [ "string" ]
  },
  "$facetResults" : [ {
    "buckets" : [ {
      "count" : 0,
      "value" : "string"
    } ],
    "name" : "string"
  } ],
  "$hits" : {
    "limit" : 0,
    "offset" : 0,
    "size" : 0,
    "total" : 0
  },
  "$results" : [ {
    "#allunitups" : [ "string" ],
    "#id" : "string",
    "#management" : {
      "AppraisalRule" : {
        "FinalAction" : "string",
        "Rules" : [ {
          "EndDate" : "string",
          "Rule" : "string",
          "StartDate" : "string"
        } ]
      }
    },
    "#max" : 0,
    "#min" : 0,
    "#nbobjects" : 0,
    "#nbunits" : 0,
    "#object" : "string",
    "#operations" : [ "string" ],
    "#opi" : "string",
    "#originating_agencies" : [ "string" ],
    "#originating_agency" : "string",
    "#qualifiers" : [ {
      "qualifier" : "string",
      "versions" : [ {
        "#id" : "string",
        "#rank" : 0,
        "#storage" : {
          "#nbc" : "string",
          "offerIds" : [ "string" ],
          "strategyId" : "string"
        },
        "Algorithm" : "string",
        "DataObjectGroupId" : "string",
        "DataObjectVersion" : "string",
        "FileInfo" : {
          "CreatingApplicationName" : "string",
          "CreatingApplicationVersion" : "string",
          "CreatingOs" : "string",
          "CreatingOsVersion" : "string",
          "DateCreatedByApplication" : "string",
          "Filename" : "string",
          "LastModified" : "string"
        },
        "FormatIdentification" : {
          "Encoding" : "string",
          "FormatId" : "string",
          "FormatLitteral" : "string",
          "MimeType" : "string"
        },
        "MessageDigest" : "string",
        "Metadata" : {
          "Audio" : "object",
          "Document" : "object",
          "Image" : "object",
          "Text" : "object",
          "Video" : "object"
        },
        "OtherMetadata" : "object",
        "PhysicalDimensions" : {
          "Depth" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Diameter" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Height" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Length" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "NumberOfPage" : 0,
          "Shape" : "string",
          "Thickness" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Weight" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "Width" : {
            "dValue" : 0.0,
            "dvalue" : 0.0,
            "unit" : "string"
          },
          "any" : [ "object" ]
        },
        "PhysicalId" : "string",
        "Size" : 0,
        "Uri" : "string"
      } ]
    } ],
    "#storage" : {
      "strategyId" : "string"
    },
    "#tenant" : 0,
    "#unitType" : "string",
    "#unitups" : [ "string" ],
    "AcquiredDate" : "string",
    "CreatedDate" : "string",
    "Description" : "string",
    "DescriptionLevel" : "string",
    "DocumentType" : "string",
    "EndDate" : "string",
    "FileInfo" : {
      "CreatingApplicationName" : "string",
      "CreatingApplicationVersion" : "string",
      "CreatingOs" : "string",
      "CreatingOsVersion" : "string",
      "DateCreatedByApplication" : "string",
      "Filename" : "string",
      "LastModified" : "string"
    },
    "InheritedRules" : {
      "AppraisalRule" : {
        "Properties" : [ {
          "PropertyName" : "string",
          "PropertyValue" : "object"
        } ],
        "Rules" : [ {
          "EndDate" : "string",
          "Rule" : "string",
          "StartDate" : "string"
        } ]
      }
    },
    "Keyword" : [ {
      "KeywordContent" : "string",
      "KeywordReference" : "string"
    } ],
    "OriginatingAgencyArchiveUnitIdentifier" : [ "string" ],
    "OriginatingSystemId" : [ "string" ],
    "PhysicalAgency" : [ "string" ],
    "PhysicalStatus" : [ "string" ],
    "PhysicalType" : [ "string" ],
    "ReceivedDate" : "string",
    "RegisteredDate" : "string",
    "SentDate" : "string",
    "StartDate" : "string",
    "Status" : "string",
    "SubmissionAgency" : {
      "Identifier" : "string"
    },
    "Title" : "string",
    "Title_" : {
      "en" : "string",
      "fr" : "string"
    },
    "TransactedDate" : "string",
    "Version" : "string",
    "Vtag" : [ {
      "Key" : [ "string" ],
      "Value" : [ "string" ]
    } ],
    "Xtag" : [ {
      "Key" : [ "string" ],
      "Value" : [ "string" ]
    } ],
    "originating_agencyName" : "string"
  } ]
}

2.2. Searchcriteriahistory

Search Criteria History Controller

2.2.1. Create search criteria history

POST /archive-search-api/archive-search/searchcriteriahistory
Paramètres
Type Nom Description Schéma

Body

entityDto
requis

entityDto

SearchCriteriaHistoryDto

Réponses
Code HTTP Description Schéma

201

Created

SearchCriteriaHistoryDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/searchcriteriahistory
Requête body
{
  "id" : "string",
  "name" : "string",
  "savingDate" : "string",
  "searchCriteriaList" : [ {
    "criteriaList" : [ {
      "criteria" : "string",
      "values" : [ "string" ]
    } ],
    "nodes" : [ "string" ]
  } ],
  "userId" : "string"
}
Exemple de réponse HTTP
Réponse 201
{
  "id" : "string",
  "name" : "string",
  "savingDate" : "string",
  "searchCriteriaList" : [ {
    "criteriaList" : [ {
      "criteria" : "string",
      "values" : [ "string" ]
    } ],
    "nodes" : [ "string" ]
  } ],
  "userId" : "string"
}

2.2.2. Get the search criteria history

GET /archive-search-api/archive-search/searchcriteriahistory
Réponses
Code HTTP Description Schéma

200

OK

< SearchCriteriaHistoryDto > array

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/searchcriteriahistory
Exemple de réponse HTTP
Réponse 200
[ {
  "id" : "string",
  "name" : "string",
  "savingDate" : "string",
  "searchCriteriaList" : [ {
    "criteriaList" : [ {
      "criteria" : "string",
      "values" : [ "string" ]
    } ],
    "nodes" : [ "string" ]
  } ],
  "userId" : "string"
} ]

2.2.3. Update Search criteria history

PUT /archive-search-api/archive-search/searchcriteriahistory/{id}
Paramètres
Type Nom Description Schéma

Body

entity
requis

entity

SearchCriteriaHistoryDto

Réponses
Code HTTP Description Schéma

200

OK

SearchCriteriaHistoryDto

Consomme
  • application/json

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/searchcriteriahistory/{id}
Requête body
{
  "id" : "string",
  "name" : "string",
  "savingDate" : "string",
  "searchCriteriaList" : [ {
    "criteriaList" : [ {
      "criteria" : "string",
      "values" : [ "string" ]
    } ],
    "nodes" : [ "string" ]
  } ],
  "userId" : "string"
}
Exemple de réponse HTTP
Réponse 200
{
  "id" : "string",
  "name" : "string",
  "savingDate" : "string",
  "searchCriteriaList" : [ {
    "criteriaList" : [ {
      "criteria" : "string",
      "values" : [ "string" ]
    } ],
    "nodes" : [ "string" ]
  } ],
  "userId" : "string"
}

2.2.4. delete Search criteria history

DELETE /archive-search-api/archive-search/searchcriteriahistory/{id}
Paramètres
Type Nom Description Schéma

Path

id
requis

id

string

Réponses
Code HTTP Description Schéma

200

OK

Pas de contenu

Exemple de requête HTTP
Requête path
/archive-search-api/archive-search/searchcriteriahistory/string

3. Définitions

3.1. AccessContractDto

Nom Description Schéma

accessLog
optionnel

Exemple : "string"

string

activationDate
optionnel

Exemple : "string"

string

creationDate
optionnel

Exemple : "string"

string

dataObjectVersion
optionnel

Exemple : [ "string" ]

< string > array

description
optionnel

Exemple : "string"

string

everyDataObjectVersion
optionnel

Exemple : true

boolean

everyOriginatingAgency
optionnel

Exemple : true

boolean

excludedRootUnits
optionnel

Exemple : [ "string" ]

< string > array

id
optionnel

Exemple : "string"

string

identifier
optionnel

Exemple : "string"

string

lastUpdate
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

originatingAgencies
optionnel

Exemple : [ "string" ]

< string > array

rootUnits
optionnel

Exemple : [ "string" ]

< string > array

ruleCategoryToFilter
optionnel

Exemple : [ "string" ]

< string > array

status
optionnel

Exemple : "string"

string

tenant
optionnel

Exemple : 0

integer (int32)

version
optionnel

Exemple : 0

integer (int32)

writingPermission
optionnel

Exemple : true

boolean

writingRestrictedDesc
optionnel

Exemple : true

boolean

3.2. AgencyDto

Nom Description Schéma

Identifier
optionnel

Exemple : "string"

string

3.3. ArchiveUnit

Nom Description Schéma

#allunitups
optionnel

Exemple : [ "string" ]

< string > array

#id
optionnel

Exemple : "string"

string

#management
optionnel

Exemple : "ManagementDto"

ManagementDto

#max
optionnel

Exemple : 0

integer (int32)

#min
optionnel

Exemple : 0

integer (int32)

#nbobjects
optionnel

Exemple : 0

integer (int32)

#nbunits
optionnel

Exemple : 0

integer (int32)

#object
optionnel

Exemple : "string"

string

#operations
optionnel

Exemple : [ "string" ]

< string > array

#opi
optionnel

Exemple : "string"

string

#originating_agencies
optionnel

Exemple : [ "string" ]

< string > array

#originating_agency
optionnel

Exemple : "string"

string

#qualifiers
optionnel

Exemple : [ "QualifiersDto" ]

< QualifiersDto > array

#storage
optionnel

Exemple : "StorageDto"

StorageDto

#tenant
optionnel

Exemple : 0

integer (int32)

#unitType
optionnel

Exemple : "string"

string

#unitups
optionnel

Exemple : [ "string" ]

< string > array

AcquiredDate
optionnel

Exemple : "string"

string

CreatedDate
optionnel

Exemple : "string"

string

Description
optionnel

Exemple : "string"

string

DescriptionLevel
optionnel

Exemple : "string"

string

DocumentType
optionnel

Exemple : "string"

string

EndDate
optionnel

Exemple : "string"

string

FileInfo
optionnel

Exemple : "FileInfoDto"

FileInfoDto

InheritedRules
optionnel

Exemple : "InheritedRulesDto"

InheritedRulesDto

Keyword
optionnel

Exemple : [ "KeywordDto" ]

< KeywordDto > array

OriginatingAgencyArchiveUnitIdentifier
optionnel

Exemple : [ "string" ]

< string > array

OriginatingSystemId
optionnel

Exemple : [ "string" ]

< string > array

PhysicalAgency
optionnel

Exemple : [ "string" ]

< string > array

PhysicalStatus
optionnel

Exemple : [ "string" ]

< string > array

PhysicalType
optionnel

Exemple : [ "string" ]

< string > array

ReceivedDate
optionnel

Exemple : "string"

string

RegisteredDate
optionnel

Exemple : "string"

string

SentDate
optionnel

Exemple : "string"

string

StartDate
optionnel

Exemple : "string"

string

Status
optionnel

Exemple : "string"

string

SubmissionAgency
optionnel

Exemple : "AgencyDto"

AgencyDto

Title
optionnel

Exemple : "string"

string

Title_
optionnel

Exemple : "TitleDto"

TitleDto

TransactedDate
optionnel

Exemple : "string"

string

Version
optionnel

Exemple : "string"

string

Vtag
optionnel

Exemple : [ "VtagDto" ]

< VtagDto > array

Xtag
optionnel

Exemple : [ "XtagDto" ]

< XtagDto > array

originating_agencyName
optionnel

Exemple : "string"

string

3.4. FacetBucketDto

Nom Description Schéma

count
optionnel

Exemple : 0

integer (int64)

value
optionnel

Exemple : "string"

string

3.5. FacetResultsDto

Nom Description Schéma

buckets
optionnel

Exemple : [ "FacetBucketDto" ]

< FacetBucketDto > array

name
optionnel

Exemple : "string"

string

3.6. FieldsDto

Nom Description Schéma

Description
optionnel

Exemple : 0

integer (int32)

Title
optionnel

Exemple : 0

integer (int32)

3.7. FileInfoDto

Nom Description Schéma

CreatingApplicationName
optionnel

Exemple : "string"

string

CreatingApplicationVersion
optionnel

Exemple : "string"

string

CreatingOs
optionnel

Exemple : "string"

string

CreatingOsVersion
optionnel

Exemple : "string"

string

DateCreatedByApplication
optionnel

Exemple : "string"

string

Filename
optionnel

Exemple : "string"

string

LastModified
optionnel

Exemple : "string"

string

3.8. FileInfoModel

Nom Description Schéma

CreatingApplicationName
optionnel

Exemple : "string"

string

CreatingApplicationVersion
optionnel

Exemple : "string"

string

CreatingOs
optionnel

Exemple : "string"

string

CreatingOsVersion
optionnel

Exemple : "string"

string

DateCreatedByApplication
optionnel

Exemple : "string"

string

Filename
optionnel

Exemple : "string"

string

LastModified
optionnel

Exemple : "string"

string

3.9. FilterDto

Nom Description Schéma

$limit
optionnel

Exemple : 0

integer (int32)

$orderby
optionnel

Exemple : "OrderbyDto"

OrderbyDto

3.10. FormatIdentificationModel

Nom Description Schéma

Encoding
optionnel

Exemple : "string"

string

FormatId
optionnel

Exemple : "string"

string

FormatLitteral
optionnel

Exemple : "string"

string

MimeType
optionnel

Exemple : "string"

string

3.11. HitsDto

Nom Description Schéma

limit
optionnel

Exemple : 0

integer (int32)

offset
optionnel

Exemple : 0

integer (int32)

size
optionnel

Exemple : 0

integer (int32)

total
optionnel

Exemple : 0

integer (int32)

3.12. InheritedPropertyDto

Nom Description Schéma

PropertyName
optionnel

Exemple : "string"

string

PropertyValue
optionnel

Exemple : "object"

object

3.13. InheritedRuleCategoryDto

Nom Description Schéma

Properties
optionnel

Exemple : [ "InheritedPropertyDto" ]

< InheritedPropertyDto > array

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.14. InheritedRulesDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "InheritedRuleCategoryDto"

InheritedRuleCategoryDto

3.15. InputStream

Type : object

3.16. JsonNode

Type : object

3.17. KeywordDto

Nom Description Schéma

KeywordContent
optionnel

Exemple : "string"

string

KeywordReference
optionnel

Exemple : "string"

string

3.18. ManagementDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "RuleCategoryDto"

RuleCategoryDto

3.19. MeasurementModel

Nom Description Schéma

dValue
optionnel

Exemple : 0.0

number

dvalue
optionnel

Exemple : 0.0

number

unit
optionnel

Exemple : "string"

string

3.20. MetadataModel

Nom Description Schéma

Audio
optionnel

Exemple : "object"

object

Document
optionnel

Exemple : "object"

object

Image
optionnel

Exemple : "object"

object

Text
optionnel

Exemple : "object"

object

Video
optionnel

Exemple : "object"

object

3.21. OrderbyDto

Nom Description Schéma

TransactedDate
optionnel

Exemple : 0

integer (int32)

3.22. PaginatedValuesDto«AccessContractDto»

Nom Description Schéma

hasMore
optionnel

Exemple : true

boolean

pageNum
optionnel

Exemple : 0

integer (int32)

pageSize
optionnel

Exemple : 0

integer (int32)

values
optionnel

Exemple : [ "AccessContractDto" ]

< AccessContractDto > array

3.23. PhysicalDimensionsModel

Nom Description Schéma

Depth
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Diameter
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Height
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Length
optionnel

Exemple : "MeasurementModel"

MeasurementModel

NumberOfPage
optionnel

Exemple : 0

integer (int32)

Shape
optionnel

Exemple : "string"

string

Thickness
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Weight
optionnel

Exemple : "MeasurementModel"

MeasurementModel

Width
optionnel

Exemple : "MeasurementModel"

MeasurementModel

any
optionnel

Exemple : [ "object" ]

< object > array

3.24. ProjectionDto

Nom Description Schéma

$fields
optionnel

Exemple : "FieldsDto"

FieldsDto

3.25. QualifiersDto

Nom Description Schéma

qualifier
optionnel

Exemple : "string"

string

versions
optionnel

Exemple : [ "VersionsDto" ]

< VersionsDto > array

3.26. QueryDTO

Nom Description Schéma

$filter
optionnel

Exemple : "QueryFilter"

QueryFilter

$projection
optionnel

Exemple : "QueryProjection"

QueryProjection

$query
optionnel

Exemple : [ "JsonNode" ]

< JsonNode > array

$roots
optionnel

Exemple : [ "string" ]

< string > array

3.27. QueryFilter

Nom Description Schéma

$limit
optionnel

Exemple : 0

integer (int32)

$offset
optionnel

Exemple : 0

integer (int32)

$orderby
optionnel

Exemple : {
"string" : 0
}

< string, integer (int32) > map

3.28. QueryProjection

Nom Description Schéma

$fields
optionnel

Exemple : {
"string" : 0
}

< string, integer (int32) > map

3.29. Resource

Nom Description Schéma

description
optionnel

Exemple : "string"

string

file
optionnel

Exemple : "file"

file

filename
optionnel

Exemple : "string"

string

inputStream
optionnel

Exemple : "InputStream"

InputStream

open
optionnel

Exemple : true

boolean

readable
optionnel

Exemple : true

boolean

uri
optionnel

Exemple : "string"

string (uri)

url
optionnel

Exemple : "string"

string (url)

3.30. ResultsDto

Nom Description Schéma

#allunitups
optionnel

Exemple : [ "string" ]

< string > array

#id
optionnel

Exemple : "string"

string

#management
optionnel

Exemple : "ManagementDto"

ManagementDto

#max
optionnel

Exemple : 0

integer (int32)

#min
optionnel

Exemple : 0

integer (int32)

#nbobjects
optionnel

Exemple : 0

integer (int32)

#nbunits
optionnel

Exemple : 0

integer (int32)

#object
optionnel

Exemple : "string"

string

#operations
optionnel

Exemple : [ "string" ]

< string > array

#opi
optionnel

Exemple : "string"

string

#originating_agencies
optionnel

Exemple : [ "string" ]

< string > array

#originating_agency
optionnel

Exemple : "string"

string

#qualifiers
optionnel

Exemple : [ "QualifiersDto" ]

< QualifiersDto > array

#storage
optionnel

Exemple : "StorageDto"

StorageDto

#tenant
optionnel

Exemple : 0

integer (int32)

#unitType
optionnel

Exemple : "string"

string

#unitups
optionnel

Exemple : [ "string" ]

< string > array

AcquiredDate
optionnel

Exemple : "string"

string

CreatedDate
optionnel

Exemple : "string"

string

Description
optionnel

Exemple : "string"

string

DescriptionLevel
optionnel

Exemple : "string"

string

DocumentType
optionnel

Exemple : "string"

string

EndDate
optionnel

Exemple : "string"

string

FileInfo
optionnel

Exemple : "FileInfoDto"

FileInfoDto

InheritedRules
optionnel

Exemple : "InheritedRulesDto"

InheritedRulesDto

Keyword
optionnel

Exemple : [ "KeywordDto" ]

< KeywordDto > array

OriginatingAgencyArchiveUnitIdentifier
optionnel

Exemple : [ "string" ]

< string > array

OriginatingSystemId
optionnel

Exemple : [ "string" ]

< string > array

PhysicalAgency
optionnel

Exemple : [ "string" ]

< string > array

PhysicalStatus
optionnel

Exemple : [ "string" ]

< string > array

PhysicalType
optionnel

Exemple : [ "string" ]

< string > array

ReceivedDate
optionnel

Exemple : "string"

string

RegisteredDate
optionnel

Exemple : "string"

string

SentDate
optionnel

Exemple : "string"

string

StartDate
optionnel

Exemple : "string"

string

Status
optionnel

Exemple : "string"

string

SubmissionAgency
optionnel

Exemple : "AgencyDto"

AgencyDto

Title
optionnel

Exemple : "string"

string

Title_
optionnel

Exemple : "TitleDto"

TitleDto

TransactedDate
optionnel

Exemple : "string"

string

Version
optionnel

Exemple : "string"

string

Vtag
optionnel

Exemple : [ "VtagDto" ]

< VtagDto > array

Xtag
optionnel

Exemple : [ "XtagDto" ]

< XtagDto > array

3.31. RuleCategoryDto

Nom Description Schéma

FinalAction
optionnel

Exemple : "string"

string

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.32. RuleDto

Nom Description Schéma

EndDate
optionnel

Exemple : "string"

string

Rule
optionnel

Exemple : "string"

string

StartDate
optionnel

Exemple : "string"

string

3.33. SearchCriteriaDto

Nom Description Schéma

criteriaList
optionnel

Exemple : [ "SearchCriteriaEltDto" ]

< SearchCriteriaEltDto > array

fieldsList
optionnel

Exemple : [ "string" ]

< string > array

language
optionnel

Exemple : "string"

string

nodes
optionnel

Exemple : [ "string" ]

< string > array

pageNumber
optionnel

Exemple : 0

integer (int32)

size
optionnel

Exemple : 0

integer (int32)

sortingCriteria
optionnel

Exemple : "SearchCriteriaSort"

SearchCriteriaSort

3.34. SearchCriteriaElementsDto

Nom Description Schéma

criteria
optionnel

Exemple : "string"

string

values
optionnel

Exemple : [ "string" ]

< string > array

3.35. SearchCriteriaEltDto

Nom Description Schéma

criteria
optionnel

Exemple : "string"

string

values
optionnel

Exemple : [ "string" ]

< string > array

3.36. SearchCriteriaHistoryDto

Nom Description Schéma

id
optionnel

Exemple : "string"

string

name
optionnel

Exemple : "string"

string

savingDate
optionnel

Exemple : "string"

string (date-time)

searchCriteriaList
optionnel

Exemple : [ "SearchCriteriasDto" ]

< SearchCriteriasDto > array

userId
optionnel

Exemple : "string"

string

3.37. SearchCriteriaSort

Nom Description Schéma

criteria
optionnel

Exemple : "string"

string

sorting
optionnel

Exemple : "string"

enum (ASC, DESC)

3.38. SearchCriteriasDto

Nom Description Schéma

criteriaList
optionnel

Exemple : [ "SearchCriteriaElementsDto" ]

< SearchCriteriaElementsDto > array

nodes
optionnel

Exemple : [ "string" ]

< string > array

3.39. StorageDto

Nom Description Schéma

strategyId
optionnel

Exemple : "string"

string

3.40. StorageJson

Nom Description Schéma

#nbc
optionnel

Exemple : "string"

string

offerIds
optionnel

Exemple : [ "string" ]

< string > array

strategyId
optionnel

Exemple : "string"

string

3.41. TitleDto

Nom Description Schéma

en
optionnel

Exemple : "string"

string

fr
optionnel

Exemple : "string"

string

3.42. VersionsDto

Nom Description Schéma

#id
optionnel

Exemple : "string"

string

#rank
optionnel

Exemple : 0

integer (int32)

#storage
optionnel

Exemple : "StorageJson"

StorageJson

Algorithm
optionnel

Exemple : "string"

string

DataObjectGroupId
optionnel

Exemple : "string"

string

DataObjectVersion
optionnel

Exemple : "string"

string

FileInfo
optionnel

Exemple : "FileInfoModel"

FileInfoModel

FormatIdentification
optionnel

Exemple : "FormatIdentificationModel"

FormatIdentificationModel

MessageDigest
optionnel

Exemple : "string"

string

Metadata
optionnel

Exemple : "MetadataModel"

MetadataModel

OtherMetadata
optionnel

Exemple : "object"

object

PhysicalDimensions
optionnel

Exemple : "PhysicalDimensionsModel"

PhysicalDimensionsModel

PhysicalId
optionnel

Exemple : "string"

string

Size
optionnel

Exemple : 0

integer (int32)

Uri
optionnel

Exemple : "string"

string

3.43. VitamSearchRequestDto

Nom Description Schéma

$filter
optionnel

Exemple : "FilterDto"

FilterDto

$projection
optionnel

Exemple : "ProjectionDto"

ProjectionDto

$query
optionnel

Exemple : [ "QueryDTO" ]

< QueryDTO > array

$roots
optionnel

Exemple : [ "string" ]

< string > array

3.44. VitamUIArchiveUnitResponseDto

Nom Description Schéma

$context
optionnel

Exemple : "VitamSearchRequestDto"

VitamSearchRequestDto

$facetResults
optionnel

Exemple : [ "FacetResultsDto" ]

< FacetResultsDto > array

$hits
optionnel

Exemple : "HitsDto"

HitsDto

$results
optionnel

Exemple : [ "ArchiveUnit" ]

< ArchiveUnit > array

3.45. VitamUISearchResponseDto

Nom Description Schéma

$context
optionnel

Exemple : "VitamSearchRequestDto"

VitamSearchRequestDto

$facetResults
optionnel

Exemple : [ "FacetResultsDto" ]

< FacetResultsDto > array

$hits
optionnel

Exemple : "HitsDto"

HitsDto

$results
optionnel

Exemple : [ "ResultsDto" ]

< ResultsDto > array

3.46. VtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array

3.47. XtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array