1. Vue générale

API externe de gestion des archives

1.1. Information de version

Version : v1

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 : Archives Search External Controller $ Mockito Mock $1406665724

  • access-contract-temp-external-controller-$-mockito-mock-$1530607306 : Access Contract Temp External Controller $ Mockito Mock $1530607306

  • basic-error-controller : Basic Error Controller

1.6. Produit

  • application/json

2. Ressources

2.1. Archives Search

Archives Search External Controller $ Mockito Mock $1406665724

2.1.1. findUnitById

GET /archives-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
/archives-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.2. downloadObjectFromUnit

GET /archives-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
/archives-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.3. exportCsvArchiveUnitsByCriteria

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

Body

param0
requis

param0

SearchCriteriaDto
Réponses
Code HTTP Description Schéma

200

OK

Resource
Consomme

  • application/json

Exemple de requête HTTP
Requête path
/archives-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.4. getFillingHoldingScheme

GET /archives-search/filling-holding-schema
Réponses
Code HTTP Description Schéma

200

OK

VitamUISearchResponseDto
Exemple de requête HTTP
Requête path
/archives-search/filling-holding-schema
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.5. searchArchiveUnitsByCriteria

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

Body

param0
requis

param0

SearchCriteriaDto
Réponses
Code HTTP Description Schéma

200

OK

ArchiveUnitsDto
Consomme

  • application/json

Exemple de requête HTTP
Requête path
/archives-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
{
  "archives" : {
    "$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"
    } ]
  },
  "id" : "string"
}

2.2. Access-contract-temp-external-controller-$-mockito-mock-$1530607306

Access Contract Temp External Controller $ Mockito Mock $1530607306

2.2.1. getAll

GET /accesscontracts
Paramètres
Type Nom Description Schéma

Query

param0
optionnel

param0

string
Réponses
Code HTTP Description Schéma

200

OK

< AccessContractDto > array
Exemple de requête HTTP
Requête path
/accesscontracts
Requête query
{
  "param0" : "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.3. Basic-error-controller

Basic Error Controller

2.3.1. errorHtml

POST /error
Réponses
Code HTTP Description Schéma

200

OK

ModelAndView
Consomme

  • application/json

Produit

  • text/html

Exemple de requête HTTP
Requête path
/error
Exemple de réponse HTTP
Réponse 200
{
  "empty" : true,
  "model" : "object",
  "modelMap" : {
    "string" : "object"
  },
  "reference" : true,
  "status" : "string",
  "view" : {
    "contentType" : "string"
  },
  "viewName" : "string"
}

2.3.2. errorHtml

GET /error
Réponses
Code HTTP Description Schéma

200

OK

ModelAndView
Produit

  • text/html

Exemple de requête HTTP
Requête path
/error
Exemple de réponse HTTP
Réponse 200
{
  "empty" : true,
  "model" : "object",
  "modelMap" : {
    "string" : "object"
  },
  "reference" : true,
  "status" : "string",
  "view" : {
    "contentType" : "string"
  },
  "viewName" : "string"
}

2.3.3. errorHtml

PUT /error
Réponses
Code HTTP Description Schéma

200

OK

ModelAndView
Consomme

  • application/json

Produit

  • text/html

Exemple de requête HTTP
Requête path
/error
Exemple de réponse HTTP
Réponse 200
{
  "empty" : true,
  "model" : "object",
  "modelMap" : {
    "string" : "object"
  },
  "reference" : true,
  "status" : "string",
  "view" : {
    "contentType" : "string"
  },
  "viewName" : "string"
}

2.3.4. errorHtml

DELETE /error
Réponses
Code HTTP Description Schéma

200

OK

ModelAndView
Produit

  • text/html

Exemple de requête HTTP
Requête path
/error
Exemple de réponse HTTP
Réponse 200
{
  "empty" : true,
  "model" : "object",
  "modelMap" : {
    "string" : "object"
  },
  "reference" : true,
  "status" : "string",
  "view" : {
    "contentType" : "string"
  },
  "viewName" : "string"
}

2.3.5. errorHtml

PATCH /error
Réponses
Code HTTP Description Schéma

200

OK

ModelAndView
Consomme

  • application/json

Produit

  • text/html

Exemple de requête HTTP
Requête path
/error
Exemple de réponse HTTP
Réponse 200
{
  "empty" : true,
  "model" : "object",
  "modelMap" : {
    "string" : "object"
  },
  "reference" : true,
  "status" : "string",
  "view" : {
    "contentType" : "string"
  },
  "viewName" : "string"
}

2.3.6. errorHtml

HEAD /error
Réponses
Code HTTP Description Schéma

200

OK

ModelAndView
Consomme

  • application/json

Produit

  • text/html

Exemple de requête HTTP
Requête path
/error
Exemple de réponse HTTP
Réponse 200
{
  "empty" : true,
  "model" : "object",
  "modelMap" : {
    "string" : "object"
  },
  "reference" : true,
  "status" : "string",
  "view" : {
    "contentType" : "string"
  },
  "viewName" : "string"
}

2.3.7. errorHtml

OPTIONS /error
Réponses
Code HTTP Description Schéma

200

OK

ModelAndView
Consomme

  • application/json

Produit

  • text/html

Exemple de requête HTTP
Requête path
/error
Exemple de réponse HTTP
Réponse 200
{
  "empty" : true,
  "model" : "object",
  "modelMap" : {
    "string" : "object"
  },
  "reference" : true,
  "status" : "string",
  "view" : {
    "contentType" : "string"
  },
  "viewName" : "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. ArchiveUnitsDto

Nom Description Schéma

archives
optionnel

Exemple : "VitamUIArchiveUnitResponseDto"

VitamUIArchiveUnitResponseDto

id
optionnel

Exemple : "string"

string

3.5. FacetBucketDto

Nom Description Schéma

count
optionnel

Exemple : 0

integer (int64)

value
optionnel

Exemple : "string"

string

3.6. FacetResultsDto

Nom Description Schéma

buckets
optionnel

Exemple : [ "FacetBucketDto" ]

< FacetBucketDto > array

name
optionnel

Exemple : "string"

string

3.7. FieldsDto

Nom Description Schéma

Description
optionnel

Exemple : 0

integer (int32)

Title
optionnel

Exemple : 0

integer (int32)

3.8. 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.9. 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.10. FilterDto

Nom Description Schéma

$limit
optionnel

Exemple : 0

integer (int32)

$orderby
optionnel

Exemple : "OrderbyDto"

OrderbyDto

3.11. 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.12. 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.13. InheritedPropertyDto

Nom Description Schéma

PropertyName
optionnel

Exemple : "string"

string

PropertyValue
optionnel

Exemple : "object"

object

3.14. InheritedRuleCategoryDto

Nom Description Schéma

Properties
optionnel

Exemple : [ "InheritedPropertyDto" ]

< InheritedPropertyDto > array

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.15. InheritedRulesDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "InheritedRuleCategoryDto"

InheritedRuleCategoryDto

3.16. InputStream

Type : object

3.17. JsonNode

Type : object

3.18. KeywordDto

Nom Description Schéma

KeywordContent
optionnel

Exemple : "string"

string

KeywordReference
optionnel

Exemple : "string"

string

3.19. ManagementDto

Nom Description Schéma

AppraisalRule
optionnel

Exemple : "RuleCategoryDto"

RuleCategoryDto

3.20. MeasurementModel

Nom Description Schéma

dValue
optionnel

Exemple : 0.0

number

dvalue
optionnel

Exemple : 0.0

number

unit
optionnel

Exemple : "string"

string

3.21. 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.22. ModelAndView

Nom Description Schéma

empty
optionnel

Exemple : true

boolean

model
optionnel

Exemple : "object"

object

modelMap
optionnel

Exemple : {
"string" : "object"
}

< string, object > map

reference
optionnel

Exemple : true

boolean

status
optionnel

Exemple : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

view
optionnel

Exemple : "View"

View

viewName
optionnel

Exemple : "string"

string

3.23. OrderbyDto

Nom Description Schéma

TransactedDate
optionnel

Exemple : 0

integer (int32)

3.24. 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.25. ProjectionDto

Nom Description Schéma

$fields
optionnel

Exemple : "FieldsDto"

FieldsDto

3.26. QualifiersDto

Nom Description Schéma

qualifier
optionnel

Exemple : "string"

string

versions
optionnel

Exemple : [ "VersionsDto" ]

< VersionsDto > array

3.27. 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.28. 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.29. QueryProjection

Nom Description Schéma

$fields
optionnel

Exemple : {
"string" : 0
}

< string, integer (int32) > map

3.30. 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.31. 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.32. RuleCategoryDto

Nom Description Schéma

FinalAction
optionnel

Exemple : "string"

string

Rules
optionnel

Exemple : [ "RuleDto" ]

< RuleDto > array

3.33. RuleDto

Nom Description Schéma

EndDate
optionnel

Exemple : "string"

string

Rule
optionnel

Exemple : "string"

string

StartDate
optionnel

Exemple : "string"

string

3.34. 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.35. SearchCriteriaEltDto

Nom Description Schéma

criteria
optionnel

Exemple : "string"

string

values
optionnel

Exemple : [ "string" ]

< string > array

3.36. SearchCriteriaSort

Nom Description Schéma

criteria
optionnel

Exemple : "string"

string

sorting
optionnel

Exemple : "string"

enum (ASC, DESC)

3.37. StorageDto

Nom Description Schéma

strategyId
optionnel

Exemple : "string"

string

3.38. StorageJson

Nom Description Schéma

#nbc
optionnel

Exemple : "string"

string

offerIds
optionnel

Exemple : [ "string" ]

< string > array

strategyId
optionnel

Exemple : "string"

string

3.39. TitleDto

Nom Description Schéma

en
optionnel

Exemple : "string"

string

fr
optionnel

Exemple : "string"

string

3.40. 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.41. View

Nom Description Schéma

contentType
optionnel

Exemple : "string"

string

3.42. 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.43. 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.44. 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.45. VtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array

3.46. XtagDto

Nom Description Schéma

Key
optionnel

Exemple : [ "string" ]

< string > array

Value
optionnel

Exemple : [ "string" ]

< string > array