Sets the items specific to projects in the content model for the repository.
Base Request
PUT /api/repository/model/project/[projectId]
where [projectId] is the alphanumeric ID for the project.
Query Parameters
Parameter | Description | Type | Required | Notes |
---|---|---|---|---|
validateOnly | True/false indicator of only validating model changes without applying them. | Boolean | Optional | Default is false. |
Headers
Header Name | Description | Required | Values |
---|---|---|---|
Authorization | The access token | Required |
Bearer [access_token]
where [access_token] is a string generated when you complete authentication (see Getting Started) |
User-Agent | Identity of the client making the request to the server | Required |
[product]/[version]
where [product] is the name of the software you are using to make the request and [version] is the numbered version of the software (for example, MyCompanyProduct/1.0). For information on other types of values commonly included in user-agent request headers, see the User-Agent HTTP header reference section on the Mozilla developer documentation website. |
HXCS-REPOSITORY | The repository ID | Optional | Any contributed repository name. Default is default. |
Accept | The format of the data to be returned | Optional | application/vnd.hxcs.v1+json |
Content-Type | The format of the data to be posted | Optional | application/json |
Request Body
See Model for request body details. The request body follows the same structure as the response body.
Sample Request
PUT /api/repository/model/project/[projectId]?validateOnly=true Authorization: Bearer [access_token] User-Agent: MyCompanyProduct/1.0 HXCS-REPOSITORY: default Accept: application/vnd.hxcs.v1+json Content-Type: application/json { "mixinTypes": { "testMT": { "noPerDocumentQuery": true } }, "primaryTypes": { "FileMT": { "extends": "SysContent", "mixins": [ "SysVersionable" ], "schemas": [ "testschema1", "file" ], "special": true, "subtypes": [ "SysFile" ] } }, "schemas": { "identifierMT": { "fields": { "nm_firstname": { "type": "string" }, "nm_lastname": { "type": "string" } }, "prefix": "nm" } } }
Response Body
See Model for response body details.
Sample Response
{ "mixinTypes": { "testMT": { "noPerDocumentQuery": true, "projectId": "PF00002" } }, "primaryTypes": { "File1": { "extends": "SysContent", "mixins": [ "SysVersionable" ], "projectId": "PF00002", "schemas": [ "testschema1", "file" ], "special": true, "subtypes": [ "SysFile", "SysFolder" ] } }, "schemas": { "test": { "fields": { "test_desc": { "type": "string" } }, "prefix": "test", "projectId": "PF00002", "proxy": true } } }
Status Codes and Errors
The following table lists the returned status codes.
Code | Description | Notes |
---|---|---|
200 | OK | Sets the items specific to projects in the existing content model and returns the model for the repository. |
204 | No Content | The provided content model is valid and can be applied. |
401 | Not Authorized | Authentication has failed or was not provided. |
403 | Not Allowed | Access permissions are invalid or missing. |
404 | Not Found | The repository could not be found. |
409 | Conflict | The proposed update for the content model already exists. |
422 | Unprocessable Entity | Updates to the content model have failed due to a validation error. |