Executes a Document operation

post https://yourorgsite.com/api/Document/_execute

Executes an operation of Document

time	status	user agent
Retrieving recent requests…

Loading…

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
}

Responses

200

The request was successful.

201

The resource was successfully created.

202

The resource was asynchronously created.

Language

Credentials

OAuth2


xxxxxxxxxx
13
1
const options = {
2
  method: 'POST',
3
  headers: {accept: 'application/json', 'content-type': 'application/json'},
4
  body: JSON.stringify({
5
    $type: 'Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts',
6
    UseJson: false
7
  })
8
};
9
10
fetch('https://yourorgsite.com/api/Document/_execute', options)
11
  .then(res => res.json())
12
  .then(res => console.log(res))
13
  .catch(err => console.error(err));

Click Try It! to start a request and see the response here!