| GET POST | /api/documents |
|---|
export class RegistrationProfileFieldValue
{
public DocumentFieldID: string;
public Value: string;
public ShadowValue: string;
public IsModifiedByUser: boolean;
public constructor(init?: Partial<RegistrationProfileFieldValue>) { (Object as any).assign(this, init); }
}
export class GetDocuments
{
public ViewID?: string;
public PageSize: number;
public PageNumber: number;
public SearchCriteria: string;
public ExplorerID?: string;
public Path: string;
public ExternalNumber: string;
public ModifiedSince?: string;
public AllVersions: boolean;
public OrderBy: string;
public Archived?: boolean;
public FilterName: string;
public ProgCode: string;
public RegistrationProfileFieldID: string;
public DependableFields: RegistrationProfileFieldValue[];
public IncludeCustomProperties: boolean;
public constructor(init?: Partial<GetDocuments>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents HTTP/1.1
Host: doapigw.baasbv.nl
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ViewID":"00000000-0000-0000-0000-000000000000","PageSize":0,"PageNumber":0,"SearchCriteria":"String","ExplorerID":"00000000-0000-0000-0000-000000000000","Path":"String","ExternalNumber":"String","ModifiedSince":"0001-01-01T00:00:00.0000000","AllVersions":false,"OrderBy":"String","Archived":false,"FilterName":"String","ProgCode":"String","RegistrationProfileFieldID":"00000000-0000-0000-0000-000000000000","DependableFields":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IncludeCustomProperties":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
[{"ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","Title":"String","FullTitle":"String","Number":"String","Version":"String","ExternalNumber":"String","ExternalVersion":"String","InternalNumber":"String","InternalInvoiceNumber":"String","PersonID":0,"RelationID":0,"RelationTitle":"String","ProjectID":0,"ProjectTitle":"String","Extension":"String","Date":"0001-01-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","Hash":"String","HashType":"String","FileUrl":"String","StandardDocumentUrl":"String","IsCorporateIdentity":false,"UserTitle":"String","IsFrozen":false,"InternalCompanyID":0,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}}]