post https://yourorgsite.com/api/Document/_execute
Executes an operation of Document
With the Document service, you can perform the following operations on the execute endpoint:
- FindByPath
- FindByVersionId
- FindByVersionIds
- FindDescendantDocumentsInFolder
- FindDocumentsInFolder
- MovePath
FindByPath
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindByPath",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "path Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String"
]
},
"UseJson": false
}
FindByPath
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindByPath",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "path Value"
},
{
"$type": "Asi.Soa.Core.ServiceContracts.RequestedPublishingState, Asi.Contracts",
"$value": "requestedPublishingState Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"Asi.Soa.Core.ServiceContracts.RequestedPublishingState, Asi.Contracts"
]
},
"UseJson": false
}
FindByVersionId
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindByVersionId",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "versionId Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String"
]
},
"UseJson": false
}
FindByVersionId
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindByVersionId",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "versionId Value"
},
{
"$type": "Asi.Soa.Core.ServiceContracts.RequestedPublishingState, Asi.Contracts",
"$value": "requestedPublishingState Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"Asi.Soa.Core.ServiceContracts.RequestedPublishingState, Asi.Contracts"
]
},
"UseJson": false
}
FindByVersionIds
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindByVersionIds",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String[]",
"$value": "versionIds Value"
},
{
"$type": "Asi.Soa.Core.ServiceContracts.RequestedPublishingState, Asi.Contracts",
"$value": "requestedPublishingState Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String[]",
"Asi.Soa.Core.ServiceContracts.RequestedPublishingState, Asi.Contracts"
]
},
"UseJson": false
}
FindDescendantDocumentsInFolder
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindDescendantDocumentsInFolder",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "folderId Value"
},
{
"$type": "System.String",
"$value": "documentTypeId Value"
},
{
"$type": "System.Boolean",
"$value": "publishedOnly Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"System.String",
"System.Boolean"
]
},
"UseJson": false
}
FindDocumentsInFolder
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "FindDocumentsInFolder",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "folderId Value"
},
{
"$type": "System.String[]",
"$value": "documentTypeIds Value"
},
{
"$type": "System.Boolean",
"$value": "publishedOnly Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"System.String[]",
"System.Boolean"
]
},
"UseJson": false
}
MovePath
BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"OperationName": "MovePath",
"EntityTypeName": "Document",
"Parameters": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
"$values": [
{
"$type": "System.String",
"$value": "path Value"
},
{
"$type": "System.String",
"$value": "newPath Value"
}
]
},
"ParameterTypeName": {
"$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
"$values": [
"System.String",
"System.String"
]
},
"UseJson": false
}