| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| GET,POST,OPTIONS | /v1/Resource |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Resource | body | List<Resource> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResourceType | form | string | No | |
| Categories | form | List<ResourceCategory> | No | |
| Documents | form | List<Document> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CategoryName | form | string | No | |
| Subcategories | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentId | form | Guid | No | |
| DocType | form | string | No | |
| DocCategory | form | string | No | |
| DocSubCategory | form | string | No | |
| DocTitle | form | string | No | |
| DocDescription | form | string | No | |
| DocData | form | byte[] | No | |
| DocExpiration | form | DateTime? | No | |
| DocMimeType | form | string | No | |
| DisplayOrder | form | int | No | |
| FileSizeInKB | form | double | No | |
| Link | form | string | No | |
| UploadDate | form | DateTime? | No | |
| DocKey | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Resource | form | List<Resource> | No |
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 /v1/Resource HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
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-01,
DocMimeType: String,
DisplayOrder: 0,
FileSizeInKB: 0,
Link: String,
UploadDate: 0001-01-01,
DocKey: String
}
]
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
DocMimeType: String,
DisplayOrder: 0,
FileSizeInKB: 0,
Link: String,
UploadDate: 0001-01-01,
DocKey: String
}
]
}
]
}