How to find out which projects a custom field is visible on using WS API in CA Agile Central?

Document ID : KB000016277
Last Modified Date : 14/02/2018
Show Technical Document Details
Question:

How can a user find out which projects a custom field is visible on using WS API in CA Agile Central?

Answer:

The schema endpoint in WS API is the optimization for discovering type definitions and attribute definitions. In order to determine which projects a custom field is visible in, you will need to query the project schema for each project to know if the attribute definition for the custom field in question exists in the response.

 

See the webservices documentation under Schema for a complete description.

 

Below is an example Schema request for Project OID 55555. The response that shows a custom field named Custom Multi for the Defect type.

GET - https://rally1.rallydev.com/slm/schema/v2.0/project/55555

In the response output:

                    {

                        "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/attributedefinition/555555566666",

                        "_refObjectName": "customMulti",

                        "_refObjectUUID": “55555555-4444-4444-44bc-55555555”,

                        "AllowedValueType": {

                            "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/typedefinition/55948544444",

                            "_refObjectName": "AllowedAttributeValue",

                            "_refObjectUUID": "db5fa78a-0c6d-4521-bb07-5555555"

                        },

                        "AllowedQueryOperators": {

                            "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/attributedefinition/5805955559/AllowedQueryOperators",

                            "_type": "AllowedQueryOperator"

                        },

                        "AllowedValues": {

                            "_ref": "https://rally1.rallydev.com/slm/webservice/v2.0/attributedefinition/58059855555/AllowedValues",

                            "_type": "AllowedAttributeValue"

                        },

                        "AttributeType": "COLLECTION",

                       ...

                 "Name": "Custom Multi",.

                ...  

                        "SchemaType": "Defectc_CustomMultiType",

 

By looking at the Name and Schema Type attributes, this custom field is available in Project 55555 for the Defect type.