Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 2.01 KB

project_availableForImage.rst

File metadata and controls

77 lines (55 loc) · 2.01 KB
Raw

project_availableForImage

.. function:: POST /orgs/{oid}/projects/{pid}/images

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.4

Gets the project if it's available for the image that will be generated.

The :ref:`project-object` object is returned if available for image by parsing the restriction rule (return null if not).

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

HTTP Request Body Parameters

A :ref:`image-object` object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/projects/{pid}/images" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

.. seealso::

         * :ref:`project-object`
         * :ref:`projectArtifact-addChild`
         * :ref:`projectArtifact-addOrRemoveFileFromCache`
         * :ref:`projectArtifact-create`
         * :ref:`projectArtifact-createFromRemoteServer`
         * :ref:`projectArtifact-delete`
         * :ref:`projectArtifact-deleteAll`
         * :ref:`projectArtifact-download`
         * :ref:`projectArtifact-downloadFile`
         * :ref:`projectArtifact-get`
         * :ref:`projectArtifact-getAll`
         * :ref:`projectArtifact-update`
         * :ref:`projectArtifact-updateAll`
         * :ref:`projectArtifact-upload`
         * :ref:`projectLogo-delete`
         * :ref:`projectLogo-download`
         * :ref:`projectLogo-downloadFile`
         * :ref:`projectLogo-upload`
         * :ref:`projectRestrictionOS-evaluate`
         * :ref:`projectRestriction-update`
         * :ref:`project-create`
         * :ref:`project-delete`
         * :ref:`project-getAll`
         * :ref:`project-update`