SiteDefinitionsLocalizationServices.GetWorkflowDefinition Method

SiteDefinitionsLocalizationServicesGetWorkflowDefinition Method

Ingeniux CMS Web Services API

Retrieves a single Workflow Definition's Localization

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<SiteDefinitionItemLocalizationData> GetWorkflowDefinition(
	SingleSiteDefitionLocalizationGetInput data
)

Public Function GetWorkflowDefinition ( 
	data As SingleSiteDefitionLocalizationGetInput
) As XHRServiceResponseGeneric(Of SiteDefinitionItemLocalizationData)

public:
virtual XHRServiceResponseGeneric<SiteDefinitionItemLocalizationData^>^ GetWorkflowDefinition(
	SingleSiteDefitionLocalizationGetInput^ data
) sealed

abstract GetWorkflowDefinition : 
        data : SingleSiteDefitionLocalizationGetInput -> XHRServiceResponseGeneric<SiteDefinitionItemLocalizationData> 
override GetWorkflowDefinition : 
        data : SingleSiteDefitionLocalizationGetInput -> XHRServiceResponseGeneric<SiteDefinitionItemLocalizationData>

Parameters

data

Type: SingleSiteDefitionLocalizationGetInput

Workflow Definition information

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "id": "WorkflowDefinitions/2",
        "label": "Workflow Definition Name:"
    }
}

Return Value

Type: XHRServiceResponseGenericSiteDefinitionItemLocalizationData

Localization of the given Workflow Definition

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "children": [{
            "name": "WorkflowTransition_WorkflowDefinitions\/2_1",
            "firstEntry": {
                "label": "Name:",
                "original": "Initial",
                "target": "",
                "name": "Name"
            },
            "isDone": false,
            "label": "Initial",
            "secondEntry": {
                "label": "Description:",
                "original": "",
                "target": "",
                "name": "Description"
            }
        }, {
            "name": "WorkflowTransition_WorkflowDefinitions\/2_2",
            "firstEntry": {
                "label": "Name:",
                "original": "Transition5",
                "target": "",
                "name": "Name"
            },
            "isDone": false,
            "label": "Transition5",
            "secondEntry": {
                "label": "Description:",
                "original": "",
                "target": "",
                "name": "Description"
            }
        }, {
            "name": "WorkflowTransition_WorkflowDefinitions\/2_3",
            "firstEntry": {
                "label": "Name:",
                "original": "Transition6",
                "target": "",
                "name": "Name"
            },
            "isDone": false,
            "label": "Transition6",
            "secondEntry": {
                "label": "Description:",
                "original": "",
                "target": "",
                "name": "Description"
            }
        }, {
            "name": "WorkflowTransition_WorkflowDefinitions\/2_4",
            "firstEntry": {
                "label": "Name:",
                "original": "Transition7",
                "target": "",
                "name": "Name"
            },
            "isDone": false,
            "label": "Transition7",
            "secondEntry": {
                "label": "Description:",
                "original": "",
                "target": "",
                "name": "Description"
            }
        }],
        "descriptionField": {
            "label": "Workflow Definition Description:",
            "original": "",
            "target": null
        },
        "nameField": {
            "label": "Workflow Definition Name:",
            "original": "Standard",
            "target": null
        }
    }
}

Remarks

If Workflow Definition doesn't exist, returns error status

If Localization for Workflow Definition doesn't exist, all the "isDone" field of transition entries are "false"

Reference

SiteDefinitionsLocalizationServices Class

IngeniuxCMService Namespace