Operation to get fileIDs from one or more pillars in a given collection.
One or all files
FileIDs can be requested either for a single file or for all files in a collection.
Requesting FileIDs for all files in a collection may yield a large set of results. Due to this the protocol supports a method of limiting which files are listed, which can be used for implementing a paging mechanism.
To be able to page through a large number of FileIDs the GetFileIDs request supports limitations on the checksum time.
The limitations are:
- Minimum timestamp
- Maximum timestamp
- Maximum number of results
Pillars responding to a GetFileIDs request should adhere to the following:
- The returned FileIDs should be ordered by their date oldest first.
- No more than the maximum number of results specified in the request should be delivered.
- If the pillar itself only allows for transmitting fewer results than specified in the request the pillar should keep to its own maximum.
- If the pillar has more FileIDs than could be sent in the response, then the response should be marked as a PartialResult.
- If limitations by minimum or maximum timestamp is present, the results should be inclusive.
- If a minimum timestamp is in place, then first result should match the minimum limitation.
- If a maximum timetamp is in place, then the last result should not be after the limitation. If the number of results is larger than the allowed maximum, the response should be marked as a PartialResult.