Creates an HCSS Plans project

post

https://api.hcssapps.com/plans/api/v1/project/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Model for creating a new Plans project

GlobalBusinessUnitId

uuid

required

The BusinessUnitId according to credentials

ProjectName

string

required

The name of the project in Plans

GlobalProjectId

uuid

The Id of the project in HeavyJobWeb

AssignDefaultPermissions

boolean

required

True if default user groups should be created automatically in the project.
The default groups are All Users, Power Users, and Administrators.
Must be set to false if a GlobalUserId is provided

GlobalUserId

uuid

UserId according to Credentials which will be automatically added to the project and associated as the project creator as if this user did so through the Plan application.
Must be set as null if AssignDefaultPermissions is true

ProjectGroupingId

uuid

required

Id of the project group this new project should be under. Valid values come from the api/public/v1/projectGrouping endpoint.

StatePlaneCode

string

Optional state plane code the project should use. If the provided state plane code is not recognized the API will silently not apply a state plane code.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad request

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

201The Id of the successfully created project