When is it necessary to use ObjectID's vs Actual value when using the Rally API
Article ID: 384301
Updated On:
Products
Issue/Introduction
We are trying to create the Rally User Story and Defect using Rally API.
Query: Most of the attributes accept the Object ID like release/Iteration filed as input instead of text description like name/description field. Please let us know when we need to provide the ObjectID's in the request body OR do we have any other way of providing input which will not require Object IDs?
URL: https://rally1.rallydev.com/slm/webservice/v2.0/hierarchicalrequirement/create
Method: Post
Request Body: {
"HierarchicalRequirement": {
"Name": "New User Story Test 1",
"Description": " New Test Data",
"Workspace": "workspace/<WorkspaceObjectID>",
"Project" : "project/<ProjectObjectID>",
"Owner" : "user/<UserObjectID>"
}
}
Resolution
If a field is part of the endpoint being used to create or update that artifact then the actual field value can be used.
If the field is NOT part of the endpoint then they will have to use a reference with an ObjectID.
Ex: If the endpoint is a Defect - The Defect Name can be sent as the actual name because "Name" is a field for the Defect Endpoint. BUT if they reference Project it will need to be project/<ObjectID> since the Project field is NOT part of the Defect endpoint.
Feedback
