| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| GET,POST,OPTIONS | /v1/Resource |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceCategory:
category_name: Optional[str] = None
subcategories: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Document:
document_id: Optional[str] = None
doc_type: Optional[str] = None
doc_category: Optional[str] = None
doc_sub_category: Optional[str] = None
doc_title: Optional[str] = None
doc_description: Optional[str] = None
doc_data: bytes = field(default_factory=list)
doc_expiration: Optional[datetime.datetime] = None
doc_mime_type: Optional[str] = None
display_order: int = 0
file_size_in_k_b: float = 0.0
link: Optional[str] = None
upload_date: Optional[datetime.datetime] = None
doc_key: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Resource:
resource_type: Optional[str] = None
categories: List[ResourceCategory] = field(default_factory=list)
documents: List[Document] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceResponse:
response_status: Optional[ResponseStatus] = None
resource: List[Resource] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceRequest:
resource: List[Resource] = field(default_factory=list)
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 /v1/Resource HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Resource":[{"ResourceType":"String","Categories":[{"CategoryName":"String","Subcategories":["String"]}],"Documents":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}]}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Resource":[{"ResourceType":"String","Categories":[{"CategoryName":"String","Subcategories":["String"]}],"Documents":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}]}]}