Query Project | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/projects/queryProject
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 queryProject operation returns details about a project in the form of a JSON object.

Request parameters

Parameter	Details
`name` (Optional)	String name of the project.
`startDate` (Optional)	Project start UTC date in ISO 8601 format.
`endDate` (Optional)	Project end UTC date in ISO 8601 format
`f` (Required)	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
{
    "projects": [
        {
            "projectId": "<String ID of the project returned>",
            "name": "<String name of the project returned>",
            "description": "<String description of the project returned>",
            "startDate": "<Optional project UTC date range start in ISO 8601 format>",
            "endDate": "<Optional project UTC date range end in ISO 8601 format>",
            "status": <numerical value associated to the status of a project: 0=unknown, 1=ready, 2=InProgress, 3=Completed, 4=Failed, 5=Canceled>,
            "phases": [
            {
                "phaseId": "<String ID of phase in the project returned>",
                "projectId": "<String ID of project associated with this phase>",
                "name": "<String name of the phase>",
                "description": "<String description of the phase",
                "startDate": "<Phase UTC date range start in ISO 8601 format>",
                "endDate": "<Phase UTC date range end in ISO 8601 format>",
                "taskGroupIds": [
                    "<String ID of associated task groups>",
                    "<String ID of associated task groups>",
                    ...
                ]
            },
            ...
            ],
            "success": <true | false>
        }
    ]
}

Example usage

Return projects that started and ended in 2018 using the queryProject operation.

Request URL and parameters:

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

Use dark colors for code blocksCopy
name=MyProject_FeatSrv
startDate=2018-01-01T00:00:00Z
endDate=2018-12-31T23:59:59Z
f=json

JSON Response example

The following snippet of a successful response shows a project with two phases:

Use dark colors for code blocksCopy
{
 "projects": [
  {
    "projectId": "BAE8F9F4-DD5C-4FCE-A87B-83C320E7D94F",
    "name": "MyProject_FeatSrv",
    "description": "Basic Description",
    "startDate": "2018-01-01T00:00:00Z",
    "endDate": "2018-12-31T23:59:59Z",
    "status": 1,
    "phases": [
      {
        "phaseId": "967A2A7C-AFAE-48DC-9C25-A33DB8D8C855",
        "projectId": "BAE8F9F4-DD5C-4FCE-A87B-83C320E7D94F",
        "name": "One",
        "description": "PhaseA Description",
        "startDate": "2018-01-01T00:00:00Z",
        "endDate": "2018-12-12T00:00:00Z",
        "taskGroupIds": [
        "5F109F09-DF73-4A82-A5B9-0FAACF8206F5"
        ]
      },
      {
        "phaseId": "29910E1D-4C7C-46AD-A35C-075B131FCBD8",
        "projectId": "BAE8F9F4-DD5C-4FCE-A87B-83C320E7D94F",
        "name": "Two",
        "description": "PhaseB Description",
        "startDate": "2018-01-10T00:00:00Z",
        "endDate": "2018-12-12T00:00:00Z",
        "taskGroupIds": [

        ]
      }
    ],
    "success": true
  },
  ...
  ]
}