Print documents helps to track InDesign documents in the panel.

GET /v3/print-document

Get tracked document.

Acl Action: PRINTDOCUMENT get

Arguments:

  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to modified_at.
  • dir - string: Either asc or desc.

Example Response:

{
    "items": [
        {
            "id": "6",
            "uuid": "AAAA-1234",
            "label": "filename.indd",
            "tracking_label": "folderfilenameindd"
            "issue_id": "6",
            "workflow_id": "2",
            "print_locked": "0",
            "print_locked_user": null,
            "created_at": "2017-03-17 19:04:19",
            "modified_at": "2017-03-24 16:24:27",
            "assignee_id": "3",
            "workflow_section_id": "0",
            "issue": {
                "id": "6",
                "uuid": "BBBB-1234",
                "label": "Test test test",
                "description": "",
                "status": "1",
                "created_at": "2017-03-21 17:41:04",
                "modified_at": "2017-03-21 17:41:04",
                "published_at": "2017-03-21 04:00:00",
                "srn": "srn:tsn:ceo-core\/issue:BBBB-1234",
                "decorated_label": "2017-03-21 - Test test test"
            },
            "workflow": {
                "id": "2",
                "uuid": "CCCC-1234",
                "slug": "to-copy",
                "name": "To Copy",
                "status": "1",
                "is_web": "1",
                "is_print": "1",
                "priority": "1",
                "is_content": "1",
                "is_assignment": "1",
                "srn": "srn:tsn:ceo-core\/workflow:CCCC-1234"
            }
        },
        ...
    ],
    "first": 1,
    "before": 1,
    "current": 1,
    "last": 1,
    "next": 1,
    "total_pages": 1,
    "total_items": 2,
    "limit": 50
}

POST /v3/print-document

Create new print document meta data. This only tracks a print document, it does not create or manage the INDD file.

Acl Action: PRINTDOCUMENT create

Example Request:

{
    'label': 'filename.indd',
    'tracking_label': 'pathstubfilenameindd',
    'workflow_id': 1,
    'issue_id': 1,
    'assignee_id': null,
    'workflow_section_id': null
}

Example Response:

[
    {
        "id": "5",
        "uuid": "DDDD-1234",
        "label": "filename.indd",
        "tracking_label": "pathstubfilenameindd",
        "issue_id": "6",
        "workflow_id": "3",
        "print_locked": "0",
        "print_locked_user": null,
        "created_at": "2017-03-17 19:04:06",
        "modified_at": "2017-03-24 16:32:38",
        "assignee_id": "3",
        "workflow_section_id": "0",
        "issue": {
            "id": "6",
            "uuid": "BBBB-1234",
            "label": "Test test test",
            "description": "",
            "status": "1",
            "created_at": "2017-03-21 17:41:04",
            "modified_at": "2017-03-21 17:41:04",
            "published_at": "2017-03-21 04:00:00",
            "srn": "srn:tsn:ceo-core\/issue:BBBB-1234",
            "decorated_label": "2017-03-21 - Test test test"
        },
        "workflow": {
            "id": "3",
            "uuid": "EEEE-1234",
            "slug": "to-edit",
            "name": "To Edit",
            "status": "1",
            "is_web": "1",
            "is_print": "1",
            "priority": "2",
            "is_content": "1",
            "is_assignment": "1",
            "srn": "srn:tsn:ceo-core\/workflow:EEEE-1234"
        }
    }

]

GET /v3/print-document/{identifier}

Fetch document meta data via identifier. The identifier can be either UUID or tracking label. The tracking label consists of the files path stub (the subfolders within the tracked sever folder) plus the path name with all non-alphanumeric characters removed.

Acl Action: PRINTDOCUMENT create

Example Response:

[
    {
        "id": "5",
        "uuid": "DDDD-1234",
        "label": "filename.indd",
        "tracking_label": "pathstubfilenameindd",
        "issue_id": "6",
        "workflow_id": "3",
        "print_locked": "0",
        "print_locked_user": null,
        "created_at": "2017-03-17 19:04:06",
        "modified_at": "2017-03-24 16:32:38",
        "assignee_id": "3",
        "workflow_section_id": "0",
        "issue": {
            "id": "6",
            "uuid": "BBBB-1234",
            "label": "Test test test",
            "description": "",
            "status": "1",
            "created_at": "2017-03-21 17:41:04",
            "modified_at": "2017-03-21 17:41:04",
            "published_at": "2017-03-21 04:00:00",
            "srn": "srn:tsn:ceo-core\/issue:BBBB-1234",
            "decorated_label": "2017-03-21 - Test test test"
        },
        "workflow": {
            "id": "3",
            "uuid": "EEEE-1234",
            "slug": "to-edit",
            "name": "To Edit",
            "status": "1",
            "is_web": "1",
            "is_print": "1",
            "priority": "2",
            "is_content": "1",
            "is_assignment": "1",
            "srn": "srn:tsn:ceo-core\/workflow:EEEE-1234"
        }
    }

]

PUT /v3/print-document/{uuid}

Update an existing document.

Acl Action: PRINTDOCUMENT update

Example Request: See POST /v3/print-assignment

Example Response: See POST /v3/print-assignment

POST /v3/print-document/{uuid}/lock

Set non-exclusive lock on a print document. If the requesting user has the PRINTDOCUMENT passThruLock ACL they may also provide a UUID under the on_behalf_of key to set the lock for another user.

Acl Action:

  • PRINTDOCUMENT update
  • PRINTDOCUMENT passThruLock - to set the lock for another user

Example Request:

{
    "on_behalf_of": "AAA-BBB-CCC"
}

Example Response: See GET /v3/print-assignment/{identifier}

DELETE /v3/print-document/{uuid}/lock

Remove non-exclusive lock on a print document. If the requesting user has the PRINTDOCUMENT passThruLock ACL this will force the removal of the lock, regardless of locking user.

Acl Action: * PRINTDOCUMENT update * PRINTDOCUMENT passThruLock - to remove the lock for another user

Example Response: See GET /v3/print-assignment/{identifier}