---
title: "ProjectData"
slug: "api/project/types/projectdata"
sidebar:
  order: 536
---

<a id="ref-e233d08a73a1"></a>
<a id="ref-9d6f340b0a12"></a>
<a id="ref-5a4e77176a22"></a>

## Synopsis

```text
struct ProjectData {
    string uri;
    string projectName;
    string projectNumber;
    string description;
    string externalReferenceNumber;
    string externalReferenceText;
    string customerNumber;
    string externalCustomerId;
    string customerRelatedRemarks;
    string company;
    string generalAgreementNumber;
    string keywords;
    AddressData[]   addresses;
    string projectGroup;
    string projectId;
    int projectVersion;
    string priceList;
    ProjectState projectState;
    dateTime created;
    dateTime lastModified;
    date projectDate;
    date validToDate;
    string createdByUser;
    string modifiedByUser;
    boolean changed;
    boolean locked;
    string lockHolder;
    dateTime lockTime;
    boolean projectNumberEditable;
    ProjectText[] projectTexts;
    string[]      languages;
}
```

See also: [AddressData](/pCon/configuratorOnline/specs/api/project/types/addressdata#ref-7538d20d8277), [ProjectState](/pCon/configuratorOnline/specs/api/project/types/projectstate#ref-bc7af713c129), dateTime *(unresolved source reference)*, date *(unresolved source reference)*, [ProjectText](/pCon/configuratorOnline/specs/api/project/types/projecttext#ref-98cd8565defb)

**projectState**

Project state

**created**

date and time the project has been created

**lastModified**

date and time the project has been created

**keywords**

A single Keyword must consist of a non-empty sequence of Unicode code points belonging to character classes LETTER, MARK, NUMBER, SYMBOL, PUNCTUATION\_CONNECTOR (e.g. '\_') or PUNCTUATION\_DASH (e.g. '-'). When keywords are set, leading and trailing white-space is allowed but will be removed. Embedded white-space and sequences of embedded white-space are replaced by a single space character (U+0020).

**uri**

Allow the URI of the current project to be explicitly set. If not set, or set to null, the path of the project file (OBK file) will be used to construct the URI.

Operations [loadSession](/pCon/configuratorOnline/specs/api/session/operations/loadsession) and [saveSession](/pCon/configuratorOnline/specs/api/session/operations/savesession) of the session service set the URI the the URL (file, http, https) used to load or save the session. Similarly, operations [loadProject](/pCon/configuratorOnline/specs/api/project/operations/loadproject) and [saveProject](/pCon/configuratorOnline/specs/api/project/operations/saveproject) set the URI to the URI used by the project database (scheme 'pst').

**projectDate**

Each project has a project date. The initial project date is derived from the project's create date.

**locked**

Present in return value of operation '[getProjectData](/pCon/configuratorOnline/specs/api/project/operations/getprojectdata)'; Note that the value 'true' means that the active/loaded project held the lock at some time during the execution of operation 'getProjectData'. At the time the client sees the value 'true' the lock may already have been stolen by someone else.

**lockHolder**

May be present in return value of operation  '[listProjects](/pCon/configuratorOnline/specs/api/project/operations/listprojects)'; The attribute is present if somebody holds the lock or this project. The attribute value represents the user associated with the session at the time the lock was acquired (the name may be empty if no user had been authenticated).

**lockTime**

May be present in return value of operation '[listProjects](/pCon/configuratorOnline/specs/api/project/operations/listprojects)'; The attribute is present if somebody holds the lock for this project. The attribute value represents the time the lock was acquired.

Contains attributes 'lockHolder' and 'lockTime' now if somebody holds the lock for the current session's project.

optional attributes 'projectGroup', 'projectId' and 'projectVersion' to return the project group, ID (an UUID) and version of a project.

Changed: Contains the project's change state (i.e. if true, the project has changed since the last load or save).

**projectNumberEditable**

The attribute is always present in return value of operations '[getProjectData](/pCon/configuratorOnline/specs/api/project/operations/getprojectdata)' and '[listProjects](/pCon/configuratorOnline/specs/api/project/operations/listprojects)'. It is ignored in input parameter of operation '[setProjectData](/pCon/configuratorOnline/specs/api/project/operations/setprojectdata)' (the reason the attribute is optional).

**projectTexts**

If the element is present, it contains a sequence of projectText elements of type [ProjectText](/pCon/configuratorOnline/specs/api/project/types/projecttext#ref-98cd8565defb).

**languages**

Containing zero or more \`language\` elements of type string. The value of each \`language\` element must be an IETF BCP47 language tag (subtags other than language, script and region are ignored)
