> Delete(ModelDeleteRequest request)
{
return await AdapterWrapper.Instance.Delete(request);
}
```
For more information about the model methods create, update and delete see the [SourceAdapter Documentation about ModelCapability](/extensibility-and-integration/source-adapter/source-adapter-interface.md#2-7-imodelcapability).
## Model / Create
`POST` `https://adapterservice/api/model/create`
To create a new instance of a class, the create method can be used.
#### Request Body
| Name | Type | Description |
| ----------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| json object | string | The request object needs a class name of an existing class and the new instance as a list of key-value pairs.
{
"className": "myClass",
"model": {
"property1": "value1",
"property2": "value2"
}
}
|
{% tabs %}
{% tab title="200 The result is the model that was newly created. If a field in the new model is autogenerated, it appears in result object (in this axample the 'created' field)." %}
```javascript
{
"value": {
"FieldStr": "value1",
"FieldInt": 5,
"FieldDate": "2019-07-29T17:16:42.9744742+02:00",
"Created": "2019-07-29T18:05:22.0143352+02:00"
},
"messages": []
}
```
{% endtab %}
{% endtabs %}
## Model / Update
`PUT` `https://adapterservice/api/model/update`
To manipulate an existing instance usually the update method is used. The ModelUpdateRequest needs the class name and a key for identify the model and the instance itself with all changed properties.
#### Request Body
| Name | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| json object | string | - className: underlying class of the instance
- key: instance identifier
- model: properties which are updated
{
"className": "myClass",
"key": {
"propertyId": "identifier"
},
"model": {
"property1": "newValue1",
"property2": "newValue2"
}
}
|
{% tabs %}
{% tab title="200 " %}
```javascript
{
"messages": []
}
```
{% endtab %}
{% endtabs %}
## Model / Delete
`DELETE` `https://adapterservice/api/model/delete`
For delete an instance (model) call the delete method. The request needs the class name and a key for identify the instance.
#### Path Parameters
| Name | Type | Description |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| json object | string | - className: underlying class of the instance
- key: instance identifier
{
"className": "myClass",
"key": {
"propertyId": "identifier"
}
}
|
{% tabs %}
{% tab title="200 If the instance deleted successfully, the message is empty." %}
```javascript
{
"messages": []
}
```
{% endtab %}
{% endtabs %}
### **3.6 DocumentController**
In order to obtain a document you have to use the *Download* method. As a result, only the content of a document is returned. This is a (byte) stream with the content type information in response header.
```csharp
public async Task Download(DocumentDownloadRequest request)
```
For better understanding of the method and the request object see chapter [IDocumentCapability in SourceAdapter](/extensibility-and-integration/source-adapter/source-adapter-interface.md#2-8-idocumentcapability).
## Document / Download
`POST` `https://adapterservice/api/document/download`
For download a content you need to send the information about the class and a document identifier. These values are set in the *DocumentDowloadRequest*. The class name is useful to assign the document content to a certain class. The key value is required to uniquely identify a document. This identifier can be a unique name, a path or a GUID as well.
#### Request Body
| Name | Type | Description |
| ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| json object | string | - className: name of the assigned class (optional)
- key: unique identifier (requred)
{
"className": "NameOfClass",
"key": "identifier"
}
|
{% tabs %}
{% tab title="200 If the call is successful the service return a FileStreamResult which represents an ActionResult that writes a file from a stream to the response and the correct content type is added to the header. If an error occurs, a SourceResult with error messages returned." %}
```
```
{% endtab %}
{% endtabs %}
Example request (json):
```javascript
{
"className": "DummyDocumentClass",
"key": "75a1bec0-c885-41c7-a93b-59e11441eac5"
}
```
### **3.7 FileUpload-StorageController**
When files need to be uploaded, the StorageController is also required. This controller ensures that the file stream and an identity key (FileId) are received on server site. The REST service provides for storage the file contents (streams) e.g. save on disk, in database or on memory cache.
```csharp
public async Task> Upload([FromForm]StoragePutRequest request)
```
## Storage / Upload
`POST` `https://adapterservice/api/storage/upload`
The upload request is a multipart/form-data content-type which consists of the file stream and the formdata FileId.
#### Request Body
| Name | Type | Description |
| ------------- | ------ | ----------------------------- |
| FileId | string | unique identifier of the file |
| (file) stream | object | the file stream |
{% tabs %}
{% tab title="200 If upload is succeeded, the message is empty." %}
```javascript
{
"messages": []
}
```
{% endtab %}
{% endtabs %}
During the upload process the platform additionally trigger an execute call (see 3.2 [ActionController](/extensibility-and-integration/source-adapter/rest-service.md#action-execute)). There is an entry in the 'parameters' dictionary with the file metadata or a list of files. For Details see the [SourceAdapter documentation](/extensibility-and-integration/source-adapter/source-adapter-interface.md#2-4-iactioncapability).
Example execute request for a list of files (json):
```javascript
{
"parameters": {
"parameter1": [
{
"FileId": "40765ec8-492f-47ed-9797-f9ff5dc35041",
"MimeType": "text/plain",
"FileName": "example01.txt"
},
{
"FileId": "21a3b5da-fd63-4b4c-be43-87a8a07121e2",
"MimeType": "text/plain",
"FileName": "example02.txt"
}
]
}
}
```
Upload asynchronous calls as sequence diagram:
It is essential for success uploading files that the upload method exist in the REST service and the adapter capability *IActionCapability* with the execute method was implemented as well. This execute method must be able to process the file parameters accordingly (see example request above).
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.tivity.one/extensibility-and-integration/source-adapter/rest-service.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.