apps/wbflex/documents/{id}/short
Gets basic summary information for a flex document.
URL
(GET) /api/apps/wbflex/documents/{id}/short
PARAMETERS
URL parameters are:
id | Specify either a document ID (such as 1000) or a job ID (such as c300). | Mandatory |
RESULTS
The result is a JSON object:
id | The flex document ID. | int |
dsid | The ID of the resource that contains the Flex document. | int |
pid | The ID of the project that contains the Flex document. | int |
name | The flex file name including any parent folders, if any. | string |
src | An object with language code ("v") and language name ("t"). | object |
trgs | An array with all target languages. Each with code ("v") and name ("t"). See example below. | object[] |
EXAMPLES
Show flex document details for Codyt job 300:
(GET) /apps/wbflex/documents/c300
Results are:
{
"id": 9371,
"dsid": 220,
"pid": 165,
"name": "games\\sample.wbflex",
"src": {
"v": "en",
"t": "Anglais"
},
"trgs": [
{
"v": "de",
"t": "Allemand"
},
{
"v": "fr",
"t": "Français"
}
]
}