extract-project-resource

• Last updated on December 29, 2023
• •
• Less than a minute to read

This command is used to extract a resource from a project and store it in the artifact repository. Resources within the project are grouped by elements (project items). To specify which resource to extract, specific parameters must be provided.

Parameters

• projectItemName (string) - The name of the item from which the resource should be extracted. If not specified, the first project item is used.
• projectItemResourceName (string) - The name of the resource to be extracted. It serves as a filter - if not specified, multiple resources that meet the conditions will be extracted.
• projectItemResourceType (string) - The type of resources to extract, one of General, Preview, or Hires. It serves as a filter - if not specified, multiple resources that meet the conditions will be extracted.

These parameters support argument interpolation following the common rules.

Example

Getting a resource by the exact match of the name.

{
    "description": "Extract resource from project",
    "name": "extracting-resource",
    "type": "extract-project-resource",
    "parameters": {
        "projectItemName": "T-Shirt",
        "projectItemResourceName": "MyResource"
    },
    "outputArtifacts": [
        "resource"
    ]
}

Getting all resources of the type Hires for the project item named T-Shirt.

{
    "description": "Extract resource from project",
    "name": "extracting-resource",
    "type": "extract-project-resource",
    "parameters": {
        "projectItemName": "T-Shirt",
        "projectItemResourceType": "Hires"
    },
    "outputArtifacts": [
        "resource*"
    ]
}