GET POST | /api/documents/{DocumentID} |
---|
export class Document implements ICustomProperties
{
public ID?: string;
public RootDocumentID?: string;
public RegistrationprofileID?: string;
public Title?: string;
public FullTitle?: string;
public Number?: string;
public Version?: string;
public ExternalNumber?: string;
public ExternalVersion?: string;
public InternalNumber?: string;
public InternalInvoiceNumber?: string;
public PersonID?: number;
public RelationID?: number;
public RelationTitle?: string;
public ProjectID?: number;
public ProjectTitle?: string;
public Extension?: string;
public Date?: string;
public CommentsCount?: number;
public HasComments?: boolean;
public HasPreview?: boolean;
public ExtraField?: string;
public IsFavorite?: boolean;
public DocumentcategoryText?: string;
public FileSize?: number;
public FileDate?: string;
public Hash?: string;
public HashType?: string;
public FileUrl?: string;
public StandardDocumentUrl?: string;
public IsCorporateIdentity?: boolean;
public UserTitle?: string;
public IsFrozen?: boolean;
public InternalCompanyID?: number;
public DirectUrl?: string;
public AllowDigitalSigningOnlyOnPrimaryVersions?: boolean;
public IsPrimaryVersion?: boolean;
public FileExtension?: string;
public CustomProperties?: { [index: string]: Object; };
public constructor(init?: Partial<Document>) { (Object as any).assign(this, init); }
}
export class GetDocumentDetails
{
public DocumentID?: string;
public IncludeCustomProperties?: boolean;
public constructor(init?: Partial<GetDocumentDetails>) { (Object as any).assign(this, init); }
}
TypeScript GetDocumentDetails DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents/{DocumentID} HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DocumentID":"00000000-0000-0000-0000-000000000000","IncludeCustomProperties":false}
HTTP/1.1 200 OK Content-Type: text/csv 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":{}}}