ExternalConceptsResource
A REST Web Service for managing External Concepts.
The following resources are applicable:
- /external-concepts/{csId}
- /external-concepts/{csId}/{conceptId}
- /external-concepts/{csId}/{id}
- /external-concepts/{csId}/type/{type}
/external-concepts/{csId}
Mount Point: /external-concepts/{csId}
GET
Retrieves all external concepts for a given change set.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path |
Response Body
| element: | externalConcepts |
| media types: | application/xml text/xml application/json |
An ExternalConcepts object containing all the external concepts
POST
Creates a new External Concept.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path |
Request Body
| element: | externalConcept |
| media types: | application/xml text/xml application/json |
The external concept data
Response Body
| element: | externalConcept |
| media types: | application/xml text/xml application/json |
The newly updated Concept
/external-concepts/{csId}/{conceptId}
Mount Point: /external-concepts/{csId}/{conceptId}
DELETE
Deletes an External Concept.
Parameters
| name | description | type | default |
|---|---|---|---|
| conceptId | The id of the external concept | path | |
| csId | The change set ID | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
200 on success, 404 on error
/external-concepts/{csId}/{id}
Mount Point: /external-concepts/{csId}/{id}
PUT
Updates an External Concept.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The concept to change | path | |
| csId | The change set ID | path |
Request Body
| element: | externalConcept |
| media types: | application/xml text/xml application/json |
The change set ID
Response Body
| element: | externalConcept |
| media types: | application/xml text/xml application/json |
The newly updated Concept
/external-concepts/{csId}/type/{type}
Mount Point: /external-concepts/{csId}/type/{type}
GET
Retrieves external concepts for a given type.
Parameters
| name | description | type | default |
|---|---|---|---|
| type | The type of the external concept, for example, "String", "Integer", "DateTime", "Boolean", "Edr", etc. | path | |
| csId | The change set ID | path |
Response Body
| element: | externalConcepts |
| media types: | application/xml text/xml application/json |
An ExternalConcepts object containing all the external concepts of the given type in the given change set