Add Project | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/projects/addProject
Methods:: GETPOST
Required Capability:: Requires a Professional or Professional Plus user type account and a Topographic Mapping server extension license.
Version Introduced:: 12.0

Description

The addProject operation adds a project to the topographic production server and associates phases with the project along with start and end dates.

Request parameters

Parameter Details

Parameter	Details
`project` (Required)	The JSON object that defines the properties of a project including phases. Syntax: Use dark colors for code blocksCopy 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 { name: “<String name of the project>”, description: “<String description of the project>”, startDate: “<Project starting UTC date in ISO 8601 format>”, endDate: “<Project ending UTC date in ISO 8601 format>”, phases: [ { name: “<String name of phase>”, description: “<String description of phase>”, startDate: “<Phase starting UTC date in ISO 8601 format>”, endDate: “<Phase ending UTC date in ISO 8601 format>”, taskGroupIds: [ <taskgroupId>, ... ] }, … ] } Example: Use dark colors for code blocksCopy 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 { name: "Project CA", description: "Mapping California", startDate: "2018-01-01T00:00:00", endDate: "2018-12-12T00:00:00", phases: [ { name: "A", description: "Northern California", startDate: "2018-01-01T00:00:00", endDate: "2018-12-12T00:00:00" }, { name: "B", description: "Central California", startDate: "2018-01-10T00:00:00", endDate: "2018-12-12T00:00:00" }, { name: "C", description: "Southern California", startDate: "2018-01-20T00:00:00", endDate: "2018-12-12T00:00:00", taskGroupIds: [ "5F109F09-DF73-4A82-A5B9-0FAACF8206F5" ] } ] }
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

project (Required)

The JSON object that defines the properties of a project including phases.

Syntax:

Use dark colors for code blocksCopy
{
name: “<String name of the project>”,
description: “<String description of the project>”,
startDate: “<Project starting UTC date in ISO 8601 format>”,
endDate: “<Project ending UTC date in ISO 8601 format>”,
phases: [
  {
    name: “<String name of phase>”,
    description: “<String description of phase>”,
    startDate: “<Phase starting UTC date in ISO 8601 format>”,
    endDate: “<Phase ending UTC date in ISO 8601 format>”,
    taskGroupIds: [
      <taskgroupId>,
      ...
      ]
  },
…
]
}

Example:

Use dark colors for code blocksCopy
{
    name: "Project CA",
    description: "Mapping California",
    startDate: "2018-01-01T00:00:00",
    endDate: "2018-12-12T00:00:00",
    phases: [
        {
            name: "A",
            description: "Northern California",
            startDate: "2018-01-01T00:00:00",
            endDate: "2018-12-12T00:00:00"
        },
        {
            name: "B",
            description: "Central California",
            startDate: "2018-01-10T00:00:00",
            endDate: "2018-12-12T00:00:00"
        },
        {
            name: "C",
            description: "Southern California",
            startDate: "2018-01-20T00:00:00",
            endDate: "2018-12-12T00:00:00",
            taskGroupIds: [
              "5F109F09-DF73-4A82-A5B9-0FAACF8206F5"
              ]
        }
    ]
}

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
{
 "project": "<Name of the project>",
 "success": <true | false>
}

Example usage

Add a project to the topographic production server using the addProject operation.

Request URL and parameters:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/<SampleService>/TopographicProductionServer/workflows/projects/addProject

Use dark colors for code blocksCopy
project={
  name: "Weapon X",
  description: "Confidential",
  startDate: "1882-01-01T00:00:00Z",
  endDate: "2023-01-01T00:00:00Z",
  phases: [
    {
      name: "James Howlett",
      description: "Discovery phase",
      startDate: "1882-01-01T00:00:00Z",
      endDate: "1900-01-01T00:00:00Z"
    },
    {
      name: "Logan",
      description: "Development",
      startDate: "1900-01-01T00:00:00Z",
      endDate: "1941-01-01T00:00:00Z"
    },
    {
      name: "Wolverine",
      description: "Fruition",
      startDate: "1941-01-01T00:00:00Z",
      endDate: "2023-01-01T00:00:00Z"
    }
  ]
  }
f=json

JSON Response example

The following is an example of a successful response:

Use dark colors for code blocksCopy
{
 "project": "Weapon X",
 "success": true
}