Versions Compared

Old Version 1

changes.mady.by.user Catch Admin

Saved on

compared with

New Version 2

changes.mady.by.user Catch Admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For more details on expansions, please see the Expand help topic.

...

Example - Get All Projects matching partial string

An example of retrieving projects matching a partial string.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
querytePartial name to match (in this case will match any project where the name beings with 'te')

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Items": [
    {
      "Id": "eb06e5d8-f774-4b0f-a95c-a911c13527a9",
      "Name": "Terrestrial monitoring",
      "OrganisationId": "ce67194e-29e2-49ee-af97-bb17aacedce0",
      "OrganisationName": "Acme Inc.",
      "ProjectCategoryId": null,
      "ProjectCategoryName": null,
      "Description": null,
      "EstimatedEndDate": null,
      "ManagerId": null,
      "ManagerUserName": null,
      "Slug": "tm",
      "AutoNumberRequirements": false,
      "AutoNumberScripts": false,
      "Independent": false,
      "RequirementNumberReadOnly": false,
      "ScriptNumberReadOnly": false,
      "OrderNumber": 0,
      "StartDate": null,
      "Expands": [
        "Statuses",
        "Priorities",
        "RequirementTypes",
        "RequirementStatuses",
        "RequirementDifficulties",
        "IncidentTypes",
        "TestTypes",
        "IncidentResolutions",
        "IncidentStatuses",
        "Versions",
        "Components",
        "ExecutionPackages",
        "ScriptPackages",
        "RequirementPackages",
        "TimeTrackingConfiguration"
      ],
      "Self": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9",
      "Links": [
        {
          "Title": "Project Tickets Search",
          "Href": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/tickets",
          "Rel": "Tickets"
        },
        {
          "Title": "Project Assignees Search",
          "Href": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/assignees",
          "Rel": "Assignees"
        },
      ]
    },{
    {
      "IdTitle": "cd69b4f5-507d-4735-b0af-8493c91b43a8",
      "Name": "Termination framework",
Widgets (Editors for entity fields)",
          "OrganisationIdHref": "ce67194e-29e2-49ee-af97-bb17aacedce0",
http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/widgets",
          "OrganisationNameRel": "Acme Inc.Widgets",
       "ProjectCategoryId": null, }
      "ProjectCategoryName": null,
]
    },
   "Description": null, {
      "EstimatedEndDateId": null"cd69b4f5-507d-4735-b0af-8493c91b43a8",
      "ManagerIdName": "Termination nullframework",
      "ManagerUserNameOrganisationId": null"ce67194e-29e2-49ee-af97-bb17aacedce0",
      "SlugOrganisationName": "tfAcme Inc.",
      "AutoNumberRequirementsProjectCategoryId": falsenull,
      "AutoNumberScriptsProjectCategoryName": falsenull,
      "IndependentDescription": falsenull,
      "RequirementNumberReadOnlyEstimatedEndDate": falsenull,
      "ScriptNumberReadOnlyManagerId": falsenull,
      "OrderNumberManagerUserName": 0null,
      "StartDateSlug": null"tf",
      "ExpandsAutoNumberRequirements": [false,
        "StatusesAutoNumberScripts": false,
        "PrioritiesIndependent": false,
        "RequirementTypesRequirementNumberReadOnly": false,
        "RequirementStatusesScriptNumberReadOnly": false,
        "RequirementDifficultiesOrderNumber": 0,
        "IncidentTypesStartDate": null,
        "TestTypesExpands",: [
        "IncidentResolutionsStatuses",
        "IncidentStatusesPriorities",
        "VersionsRequirementTypes",
        "ComponentsRequirementStatuses",
        "ExecutionPackagesRequirementDifficulties",
        "ScriptPackagesIncidentTypes",
        "RequirementPackagesTestTypes",
        "TimeTrackingConfigurationIncidentResolutions",
        ]"IncidentStatuses",
       "Self": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8 "Versions",
        "LinksComponents": [,
        {
  "ExecutionPackages",
        "TitleScriptPackages":,
  "Project Tickets Search     "RequirementPackages",
        "TimeTrackingConfiguration"
      "Href],
      "Self": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8/tickets",
          "RelLinks": "Tickets"
        },
[
         {
          "Title": "Project AssigneesTickets Search",
          "Href": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8/assigneestickets",
          "Rel": "AssigneesTickets"
        },
      ]  {
    }
   ]   "Title": "Project Assignees Search",
  "Self        "Href": "http://localhost/api/api/projectsearch?query=te"
}

Status Code

200 - OK

POST

Retrieves all (or a subset) of projects that are visible to the user (using POST to allow large existing value queries).

Required Permissions

  • TestManagement/View

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
/project/cd69b4f5-507d-4735-b0af-8493c91b43a8/assignees",
          "Rel": "Assignees"
        },
        {
          "Title": "Widgets (Editors for entity fields)",
          "Href": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8/widgets",
          "Rel": "Widgets"
        }
      ]
    }
  ],
  "Self": "http://localhost/api/api/projectsearch?query=te"
}

Status Code

200 - OK

POST

...

Retrieves all (or a subset) of projects that are visible to the user (using POST to allow large existing value queries).

Required Permissions

  • TestManagement/View

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.

Example - Get All Projects matching partial string

An example of retrieving projects matching a partial string.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
querytePartial name to match (in this case will match any project where the name beings with 'te')

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Items": [
    {
      "Id": "eb06e5d8-f774-4b0f-a95c-a911c13527a9",
      "Name": "Terrestrial monitoring",
      "OrganisationId": "ce67194e-29e2-49ee-af97-bb17aacedce0",
      "OrganisationName": "Acme Inc.",
      "ProjectCategoryId": null,
      "ProjectCategoryName": null,
      "Description": null,
      "EstimatedEndDate": null,
      "ManagerId": null,
      "ManagerUserName": null,
Example - Get All Projects matching partial string

An example of retrieving projects matching a partial string.

Request Headers

KeyValueDescriptionAcceptapplication/json

Request Parameters

KeyValueDescription
querytePartial name to match (in this case will match any project where the name beings with 'te')

Response Headers

KeyValueDescriptionContent-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Items": [
    {
      "IdSlug": "eb06e5d8-f774-4b0f-a95c-a911c13527a9tm",
      "NameAutoNumberRequirements": "Terrestrial monitoring"false,
      "OrganisationIdAutoNumberScripts": "ce67194e-29e2-49ee-af97-bb17aacedce0"false,
      "OrganisationNameIndependent": "Acme Inc."false,
      "ProjectCategoryIdRequirementNumberReadOnly": nullfalse,
      "ProjectCategoryNameScriptNumberReadOnly": nullfalse,
      "DescriptionOrderNumber": null0,
      "EstimatedEndDateStartDate": null,
      "ManagerIdExpands": null,[
        "ManagerUserNameStatuses": null,
       "Slug": "tmPriorities",
        "AutoNumberRequirementsRequirementTypes": false,
        "AutoNumberScriptsRequirementStatuses": false,
        "IndependentRequirementDifficulties": false,
        "RequirementNumberReadOnlyIncidentTypes": false,
        "ScriptNumberReadOnlyTestTypes": false,
        "OrderNumberIncidentResolutions": 0,
        "StartDateIncidentStatuses": null,
        "ExpandsVersions": [,
        "StatusesComponents",
        "PrioritiesExecutionPackages",
        "RequirementTypesScriptPackages",
        "RequirementStatusesRequirementPackages",
        "RequirementDifficultiesTimeTrackingConfiguration",
        "IncidentTypes"],
        "TestTypes"Self": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9",
        "IncidentResolutionsLinks",: [
        "IncidentStatuses",
{
          "VersionsTitle": "Project Tickets Search",
         "Components  "Href": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/tickets",
          "Rel": "ExecutionPackagesTickets",
        "ScriptPackages"},
        "RequirementPackages",
{
          "Title"TimeTrackingConfiguration: "
Project Assignees Search",
    ],
      "SelfHref": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/assignees",
          "LinksRel": [ "Assignees"
        },
        {
          "Title": "Project Tickets SearchWidgets (Editors for entity fields)",
          "Href": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/ticketswidgets",
          "Rel": "TicketsWidgets"
        },
        {]
          "Title": "Project Assignees Search"},
    {
      "HrefId": "http://localhost/api/project/eb06e5d8-f774-4b0f-a95c-a911c13527a9/assignees",
    cd69b4f5-507d-4735-b0af-8493c91b43a8",
      "RelName": "AssigneesTermination framework",
        }"OrganisationId": "ce67194e-29e2-49ee-af97-bb17aacedce0",
      ]
    }"OrganisationName": "Acme Inc.",
    {
  "ProjectCategoryId": null,
    "Id": "cd69b4f5-507d-4735-b0af-8493c91b43a8"  "ProjectCategoryName": null,
      "NameDescription": "Termination framework"null,
      "OrganisationIdEstimatedEndDate": "ce67194e-29e2-49ee-af97-bb17aacedce0"null,
      "OrganisationNameManagerId": "Acme Inc."null,
      "ProjectCategoryIdManagerUserName": null,
      "ProjectCategoryNameSlug": null"tf",
      "DescriptionAutoNumberRequirements": nullfalse,
      "EstimatedEndDateAutoNumberScripts": nullfalse,
      "ManagerIdIndependent": nullfalse,
      "ManagerUserNameRequirementNumberReadOnly": nullfalse,
      "SlugScriptNumberReadOnly": "tf"false,
      "AutoNumberRequirementsOrderNumber": false0,
      "AutoNumberScriptsStartDate": falsenull,
      "IndependentExpands": false,[
        "RequirementNumberReadOnlyStatuses": false,
        "ScriptNumberReadOnlyPriorities": false,
        "OrderNumberRequirementTypes": 0,
        "StartDateRequirementStatuses": null,
        "ExpandsRequirementDifficulties": [,
        "StatusesIncidentTypes",
        "PrioritiesTestTypes",
        "RequirementTypesIncidentResolutions",
        "RequirementStatusesIncidentStatuses",
        "RequirementDifficultiesVersions",
        "IncidentTypesComponents",
        "TestTypesExecutionPackages",
        "IncidentResolutionsScriptPackages",
        "IncidentStatusesRequirementPackages",
        "VersionsTimeTrackingConfiguration",
        "Components"],
        "ExecutionPackages"Self": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8",
        "ScriptPackagesLinks",: [
        "RequirementPackages",
{
          "Title"TimeTrackingConfiguration: "
Project Tickets Search",
    ],
      "SelfHref": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8/tickets",
          "LinksRel": [ "Tickets"
        },
        {
          "Title": "Project TicketsAssignees Search",
          "Href": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8/ticketsassignees",
          "Rel": "TicketsAssignees"
        },
        {
          "Title": "Project Assignees SearchWidgets (Editors for entity fields)",
          "Href": "http://localhost/api/project/cd69b4f5-507d-4735-b0af-8493c91b43a8/assigneeswidgets",
          "Rel": "AssigneesWidgets"
        }
      ]
    }
  ],
  "Self": "http://localhost/api/api/projectsearch"
}

Status Code

200 - OK

...