SiteDefinitionsLocalizationServices.GetWorkstate Method

SiteDefinitionsLocalizationServicesGetWorkstate Method

Ingeniux CMS Web Services API

Retrieves a single Workstate's localization

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<SiteDefinitionItemLocalizationData> GetWorkstate(
	SingleSiteDefitionLocalizationGetInput data
)

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

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

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

Parameters

data

Type: SingleSiteDefitionLocalizationGetInput

Workstate Id and its current name

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "id": "WorkStates/38",
        "label": "Workflow State Name:"
    }
}

Return Value

Type: XHRServiceResponseGenericSiteDefinitionItemLocalizationData

Localization of the given Workstate

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "children": null,
        "descriptionField": {
            "label": "Workflow State Description:",
            "original": "",
            "target": ""
        },
        "nameField": {
            "label": "Workflow State Name:",
            "original": "Publishing",
            "target": ""
        }
    }
}

Remarks

If Workstate doesn't exist, returns error status

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

Reference

SiteDefinitionsLocalizationServices Class

IngeniuxCMService Namespace