HomeGuidesAPI ReferenceChangelogDiscussions
GuidesiMIS ProfessionaliMIS EnterpriseClient SupportLog In
API Reference
These docs are for v20.3.44. Click to read the latest docs for v20.3.192.

Executes a GenericExecuteRequest

Executes an operation of Document

With the Document service, you can perform the following operations on the execute endpoint:

  • FindByPath
  • FindByPath (with RequestedPublishingState)
  • FindByVersionId
  • FindByVersionId (with RequestedPublishingState)
  • FindByVersionIds
  • FindDescendantDocumentsInFolder
  • FindDocumentsInFolder

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 (with RequestedPublishingState)

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",
                "$value": "requestedPublishingState Value"
            }
        ]
    },
    "ParameterTypeName": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String",
            "Asi.Soa.Core.ServiceContracts.RequestedPublishingState"
        ]
    },
    "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 (with RequestedPublishingState)

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",
                "$value": "requestedPublishingState Value"
            }
        ]
    },
    "ParameterTypeName": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String",
            "Asi.Soa.Core.ServiceContracts.RequestedPublishingState"
        ]
    },
    "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[]",
                "$values": ["versionIds Value", "versionIds Value 2"]
            },
            {
                "$type": "Asi.Soa.Core.ServiceContracts.RequestedPublishingState",
                "$value": "requestedPublishingState Value"
            }
        ]
    },
    "ParameterTypeName": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String[]",
            "Asi.Soa.Core.ServiceContracts.RequestedPublishingState"
        ]
    },
    "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[]",
                "$values": ["documentTypeIds Value", "documentTypeIds Value 2"]
            },
            {
                "$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
}
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!

Contact us
Copyright © Advanced Solutions International, All rights reserved.