apps/wbflex/documents/{id}

Gets summary information for a flex document.

URL

^{(GET) /api/apps/wbflex/documents/{id}}

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
dtchange	Date of last change of content. Content is changed either when pushing content with the API or editing in the Wordbee Translation editor.	datetime
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[]
filterName	The Flex configuration name that was used when the document was created. This can be done in Wordbee Translator or via API: apps/wbflex/documents (POST)	string
files	An array with any files that accompany the flex document. These are files saved to the same folder as the flex file in the project library (under the source language). These can be instructions or any other information made available for download or upload. Each file is an object with file name ("name"), change date ("date") and size in bytes ("size").	object[]

EXAMPLES

Show flex document details for Codyt job 300:

^{(GET) /apps/wbflex/documents/c300}

Results are:

CODE

{
    "id": 9371,
    "dsid": 220,
    "pid": 165,
    "name": "games\\sample.wbflex",
    "src": {
        "v": "en",
        "t": "Anglais"
    },
    "dtchange": "2019-05-19T12:44:22.8270208Z",
    "trgs": [
        {
            "v": "de",
            "t": "Allemand"
        },
        {
            "v": "fr",
            "t": "Français"
        }
    ],
    "files": [
        {
            "name": "Instructions.docx",
            "date": "2019-05-17T12:44:38.8070208Z",
            "size": 32892
        }
    ]
}