Skip to main content

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[]

isCodyt

Boolean. True if the project is a Codyt project, false if it is a Standard project. Some newer features may be available in Standard only.

bool

hasBranches

Indicates if branching is enabled in the project’s workflow & supplier settings.

bool

hasBranchPropagation

Indicates if a branch propagation script was installed by the Wordbee solutions team (on demand by the platform owner). This is a pre-requisite for all branch-propagation features.

bool

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"
    },
    "trgs": [
        {
            "v": "de",
            "t": "Allemand"
        },
        {
            "v": "fr",
            "t": "Français"
        }
    ]
}





JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.