JSON API - addProperties

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addProperties

PREMIUM

TRIAL / ADVANCED

Modifies the document properties.

Note

You are reading the JSON API documentation. For the PHP API method please go to addProperties.

JSON data

{
    "title": "string",
    "subject": "string",
    "creator": "string",
    "keywords": "string",
    "description": "string",
    "category": "string",
    "Manager": "string",
    "Company": "string",
    "contentStatus": "string",
    "created": "string",
    "modified": "string",
    "lastModifiedBy": "string",
    "revision": "string",
    "custom": object
}

Key	Description
title	The title of the document.
subject	The subject of the document.
creator	The document author or creator.
keywords	A list of keywords that may be separated by any character you wish.
description	The description of the document.
category	The category to which you want to associate the document.
Manager	The name of the associated Manager.
Company	The company name.
contentStatus	The current status of the document: final, draft...
created	The created date (W3CDTF without time zone).
modified	The modified date (W3CDTF without time zone).
lastModifiedBy	The username that modified the document.
revision	The revision number.
custom	An object of custom properties. Each entry is composed by the name of the property as key and a value that is itself an object with the type and actual value of the variable.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addProperties",
            "data": {
                "title": "My title",
                "subject": "My subject",
                "creator": "The creator",
                "keywords": "keyword 1, keyword 2, keyword 3",
                "description": "The description could be much longer than this",
                "category": "My category",
                "contentStatus": "Draft",
                "Manager": "The boss",
                "Company": "My company",
                "custom": {
                    "My custom text": { "text": "This is a reasonably large text" },
                    "My custom number": { "number": "4567" },
                    "My custom date": { "date": "1962-01-27T23:00:00Z" },
                    "My custom boolean": { "boolean": true }
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
                "optionsParagraph": {
                    "bold": true,
                    "font": "Arial"
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.