| GET POST | /api/documents |
|---|
"use strict";
export class RegistrationProfileFieldValue {
/** @param {{DocumentFieldID?:string,Value?:string,ShadowValue?:string,IsModifiedByUser?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
DocumentFieldID;
/** @type {string} */
Value;
/** @type {string} */
ShadowValue;
/** @type {boolean} */
IsModifiedByUser;
}
export class GetDocuments {
/** @param {{ViewID?:string,PageSize?:number,PageNumber?:number,SearchCriteria?:string,ExplorerID?:string,Path?:string,ExternalNumber?:string,ModifiedSince?:string,AllVersions?:boolean,OrderBy?:string,Archived?:boolean,FilterName?:string,ProgCode?:string,RegistrationProfileFieldID?:string,DependableFields?:RegistrationProfileFieldValue[],IncludeCustomProperties?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
ViewID;
/** @type {number} */
PageSize;
/** @type {number} */
PageNumber;
/** @type {string} */
SearchCriteria;
/** @type {?string} */
ExplorerID;
/** @type {string} */
Path;
/** @type {string} */
ExternalNumber;
/** @type {?string} */
ModifiedSince;
/** @type {boolean} */
AllVersions;
/** @type {string} */
OrderBy;
/** @type {?boolean} */
Archived;
/** @type {string} */
FilterName;
/** @type {string} */
ProgCode;
/** @type {string} */
RegistrationProfileFieldID;
/** @type {RegistrationProfileFieldValue[]} */
DependableFields;
/** @type {boolean} */
IncludeCustomProperties;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: dogw.klokgroep.nl
Accept: text/jsv
Content-Type: text/jsv
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-01,
AllVersions: False,
OrderBy: String,
Archived: False,
FilterName: String,
ProgCode: String,
DependableFields:
[
{
Value: String,
ShadowValue: String,
IsModifiedByUser: False
}
],
IncludeCustomProperties: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
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-01,
CommentsCount: 0,
HasComments: False,
HasPreview: False,
ExtraField: String,
IsFavorite: False,
DocumentcategoryText: String,
FileSize: 0,
FileDate: 0001-01-01,
Hash: String,
HashType: String,
FileUrl: String,
StandardDocumentUrl: String,
IsCorporateIdentity: False,
UserTitle: String,
IsFrozen: False,
InternalCompanyID: 0,
InternalLocationID: 0,
LanguageID: 0,
DirectUrl: String,
AllowDigitalSigningOnlyOnPrimaryVersions: False,
IsPrimaryVersion: False,
FileExtension: String,
CustomProperties:
{
String: {}
}
}
]