Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Cloud Service Automation4.80.0002

Develop > Application Programming Interface > Legacy APIs > Artifact API

Artifact API

Use this API to view, create, and modify artifacts.

Note This REST API is supported only for sequenced designs and not for topology designs.

Base URL

https://<host>:<port>/csa/rest

URIs

The following URIs are appended to the base URL:

Artifact

URI	Method	Parameters	Description
/artifact	POST	userIdentifier	Create an artifact
/artifact/<artifact_id>	GET	userIdentifier, scope, detail, view	View an artifact
/artifact/<artifact_id>	PUT	userIdentifier, scope, view	Update an artifact
/artifact/<artifact_id>	DELETE	userIdentifier	Delete an artifact
/artifact/fastview/<artifact_id>	GET	userIdentifier, view	Retrieve a predefined view for an artifact
/artifact/<artifact_id>/resolveProperties	GET	userIdentifier, propertyName	Retrieve resolved properties for an artifact

Group

URI	Method	Parameters	Description
/artifact/<organization_id>/group	GET	userIdentifier	List active groups associated with an organization
/artifact/<organization_id>/group	POST	userIdentifier	Add groups to an organization
/artifact/<organization_id>/group/<grou_id>	PUT	userIdentifier	Update group display name, distinguished name
/artifact/<organization_id>/group/<group_id>	DELETE	userIdentifier	Disassociate group from an organization

Resource Provider

URI	Method	Parameters	Description
/artifact	GET	userIdentifier, artifactType	List resource providers

Service Offering

URI	Method	Parameters	Description
/artifact/<service_offering_id>/document	POST	userIdentifier	Add document to service offering
/artifact/<service_offering_id>/document	DELETE	userIdentifier	Delete document from service offering
/artifact/<service_offering_id>/document/<document_id>	POST	userIdentifier	Update document in service offering
/artifact/<catalog_id>/publish	POST	userIdentifier	Publish service offerings to catalog
/artifact/<catalog_id>/unpublish	POST	userIdentifier	Unpublish service offerings from catalog

Note You can view information about an artifact with GET /artifact/<artifact_id> or GET /artifact/fastview/<artifact_id>. The fastview API can traverse associations, while the standard artifact API only returns information for the artifact.

Send Help Center feedback