Community Action Templates

Get a list of Community Action Templates

GET /api/communityactiontemplates

Query Parameters

skip integer
Number of items to skip. Defaults to zero. Minimum 0.
take integer
Number of items to take. Defaults to 30. Minimum 0.

Response

200 — List of Community Action Templates.

Id string
Gets or sets a unique identifier for this resource.
ItemType string
Items array of object
- Author string
- Description string
- HistoryUrl string
- Id string
- Links object
- Name string
- Packages array of object
- Parameters array of object
- Properties object
- Type string
- Version integer
- Website string
ItemsPerPage integer
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LastPageNumber integer
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
NumberOfPages integer
TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Author": "string",
      "Description": "string",
      "HistoryUrl": "string",
      "Id": "string",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "Packages": [
        {}
      ],
      "Parameters": [
        {}
      ],
      "Properties": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      },
      "Type": "string",
      "Version": 0,
      "Website": "string"
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

Get a Community Action Template by ID

GET /api/communityactiontemplates/{id}

Path Parameters

id string (required)
ID of the CommunityActionTemplate to load.

Response

200 — The requested Community Action Template.

Author string
Description string
HistoryUrl string
Id string
Links object
Name string
Packages array of object
- AcquisitionLocation string
  The package-acquisition location. One of PackageAcquisitionLocationResource or a variable-expression.
- FeedId string
  Feed ID, name or a variable-expression.
- Id string
- Name string
  A name for the package-reference. This may be empty. This is used to discriminate the package-references. Package ID isn’t suitable because an action may potentially have multiple references to the same package ID (e.g. if you wanted to use different versions of the same package). Also, the package ID may be a variable-expression.
- PackageId string
  Package ID or a variable-expression.
- Properties object
- StepPackageInputsReferenceId string
  This reference identifier is populated when a step package step contains a package reference It allows us to correlate the reference within the step package inputs to this Server package reference.
- Version string
  Specific version to use for this package. If not specified, package can be selected at release creation or runbook run time.
Parameters array of object
- DefaultValue object
- DisplaySettings object
- HelpText string
- Id string
- Label string
- Name string
Properties object
Type string
Version integer
Website string

{
  "Author": "string",
  "Description": "string",
  "HistoryUrl": "string",
  "Id": "string",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Packages": [
    {
      "AcquisitionLocation": "string",
      "FeedId": "string",
      "Id": "string",
      "Name": "string",
      "PackageId": "string",
      "Properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "StepPackageInputsReferenceId": "string",
      "Version": "string"
    }
  ],
  "Parameters": [
    {
      "DefaultValue": {
        "IsSensitive": true,
        "SensitiveValue": {},
        "Value": "string"
      },
      "DisplaySettings": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "HelpText": "string",
      "Id": "string",
      "Label": "string",
      "Name": "string"
    }
  ],
  "Properties": {
    "additionalProp1": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp2": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp3": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    }
  },
  "Type": "string",
  "Version": 0,
  "Website": "string"
}

Get installed version of the template

GET /api/communityactiontemplates/{id}/actiontemplate/{actiontemplatespaceId}

Also reachable at /api/communityactiontemplates/{id}/actiontemplate.

Path Parameters

actiontemplatespaceId string (required)
Then ID of the space where the Action Template can be located.
id string (required)
The ID of the Community Action Template.

Response

200 — The installed version of the template.

ActionType string
Minimum length 1.
CommunityActionTemplateId string
Description string
GitDependencies array of object
- DefaultBranch string
  Minimum length 1.
- FilePathFilters array of string
- GitCredentialId string
- GitCredentialType string
  Minimum length 1.
- GitHubConnectionId string
- Name string
- RepositoryUri string
  Minimum length 1.
- StepPackageInputsReferenceId string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Minimum length 1.
Packages array of object
- AcquisitionLocation string
  The package-acquisition location. One of PackageAcquisitionLocationResource or a variable-expression.
- FeedId string
  Feed ID, name or a variable-expression.
- Id string
- Name string
  A name for the package-reference. This may be empty. This is used to discriminate the package-references. Package ID isn’t suitable because an action may potentially have multiple references to the same package ID (e.g. if you wanted to use different versions of the same package). Also, the package ID may be a variable-expression.
- PackageId string
  Package ID or a variable-expression.
- Properties object
- StepPackageInputsReferenceId string
  This reference identifier is populated when a step package step contains a package reference It allows us to correlate the reference within the step package inputs to this Server package reference.
- Version string
  Specific version to use for this package. If not specified, package can be selected at release creation or runbook run time.
Parameters array of object
- DefaultValue object
- DisplaySettings object
- HelpText string
- Id string
- Label string
- Name string
Properties object
SpaceId string
Version integer

{
  "ActionType": "string",
  "CommunityActionTemplateId": "string",
  "Description": "string",
  "GitDependencies": [
    {
      "DefaultBranch": "string",
      "FilePathFilters": [
        "string"
      ],
      "GitCredentialId": "string",
      "GitCredentialType": "string",
      "GitHubConnectionId": "string",
      "Name": "string",
      "RepositoryUri": "string",
      "StepPackageInputsReferenceId": "string"
    }
  ],
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Packages": [
    {
      "AcquisitionLocation": "string",
      "FeedId": "string",
      "Id": "string",
      "Name": "string",
      "PackageId": "string",
      "Properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "StepPackageInputsReferenceId": "string",
      "Version": "string"
    }
  ],
  "Parameters": [
    {
      "DefaultValue": {
        "IsSensitive": true,
        "SensitiveValue": {},
        "Value": "string"
      },
      "DisplaySettings": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "HelpText": "string",
      "Id": "string",
      "Label": "string",
      "Name": "string"
    }
  ],
  "Properties": {
    "additionalProp1": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp2": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp3": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    }
  },
  "SpaceId": "string",
  "Version": 0
}

Install community step template

POST /api/communityactiontemplates/{id}/installation/{actiontemplatespaceId}

Also reachable at /api/communityactiontemplates/{id}/installation.

Path Parameters

actiontemplatespaceId string (required)
The ID of the Space where the action template should be installed.
id string (required)
The ID of the community action template.

Response

201 — Created

ActionType string
Minimum length 1.
CommunityActionTemplateId string
Description string
GitDependencies array of object
- DefaultBranch string
  Minimum length 1.
- FilePathFilters array of string
- GitCredentialId string
- GitCredentialType string
  Minimum length 1.
- GitHubConnectionId string
- Name string
- RepositoryUri string
  Minimum length 1.
- StepPackageInputsReferenceId string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Minimum length 1.
Packages array of object
- AcquisitionLocation string
  The package-acquisition location. One of PackageAcquisitionLocationResource or a variable-expression.
- FeedId string
  Feed ID, name or a variable-expression.
- Id string
- Name string
  A name for the package-reference. This may be empty. This is used to discriminate the package-references. Package ID isn’t suitable because an action may potentially have multiple references to the same package ID (e.g. if you wanted to use different versions of the same package). Also, the package ID may be a variable-expression.
- PackageId string
  Package ID or a variable-expression.
- Properties object
- StepPackageInputsReferenceId string
  This reference identifier is populated when a step package step contains a package reference It allows us to correlate the reference within the step package inputs to this Server package reference.
- Version string
  Specific version to use for this package. If not specified, package can be selected at release creation or runbook run time.
Parameters array of object
- DefaultValue object
- DisplaySettings object
- HelpText string
- Id string
- Label string
- Name string
Properties object
SpaceId string
Version integer

{
  "ActionType": "string",
  "CommunityActionTemplateId": "string",
  "Description": "string",
  "GitDependencies": [
    {
      "DefaultBranch": "string",
      "FilePathFilters": [
        "string"
      ],
      "GitCredentialId": "string",
      "GitCredentialType": "string",
      "GitHubConnectionId": "string",
      "Name": "string",
      "RepositoryUri": "string",
      "StepPackageInputsReferenceId": "string"
    }
  ],
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Packages": [
    {
      "AcquisitionLocation": "string",
      "FeedId": "string",
      "Id": "string",
      "Name": "string",
      "PackageId": "string",
      "Properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "StepPackageInputsReferenceId": "string",
      "Version": "string"
    }
  ],
  "Parameters": [
    {
      "DefaultValue": {
        "IsSensitive": true,
        "SensitiveValue": {},
        "Value": "string"
      },
      "DisplaySettings": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "HelpText": "string",
      "Id": "string",
      "Label": "string",
      "Name": "string"
    }
  ],
  "Properties": {
    "additionalProp1": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp2": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp3": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    }
  },
  "SpaceId": "string",
  "Version": 0
}

Update installed community step template to the latest version

PUT /api/communityactiontemplates/{id}/installation/{actiontemplatespaceId}

Also reachable at /api/communityactiontemplates/{id}/installation.

Path Parameters

actiontemplatespaceId string (required)
The ID of the Space where the action template should be installed.
id string (required)
The ID of the community action template.

Response

200 — The updated Action Template.

ActionType string
Minimum length 1.
CommunityActionTemplateId string
Description string
GitDependencies array of object
- DefaultBranch string
  Minimum length 1.
- FilePathFilters array of string
- GitCredentialId string
- GitCredentialType string
  Minimum length 1.
- GitHubConnectionId string
- Name string
- RepositoryUri string
  Minimum length 1.
- StepPackageInputsReferenceId string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Minimum length 1.
Packages array of object
- AcquisitionLocation string
  The package-acquisition location. One of PackageAcquisitionLocationResource or a variable-expression.
- FeedId string
  Feed ID, name or a variable-expression.
- Id string
- Name string
  A name for the package-reference. This may be empty. This is used to discriminate the package-references. Package ID isn’t suitable because an action may potentially have multiple references to the same package ID (e.g. if you wanted to use different versions of the same package). Also, the package ID may be a variable-expression.
- PackageId string
  Package ID or a variable-expression.
- Properties object
- StepPackageInputsReferenceId string
  This reference identifier is populated when a step package step contains a package reference It allows us to correlate the reference within the step package inputs to this Server package reference.
- Version string
  Specific version to use for this package. If not specified, package can be selected at release creation or runbook run time.
Parameters array of object
- DefaultValue object
- DisplaySettings object
- HelpText string
- Id string
- Label string
- Name string
Properties object
SpaceId string
Version integer

{
  "ActionType": "string",
  "CommunityActionTemplateId": "string",
  "Description": "string",
  "GitDependencies": [
    {
      "DefaultBranch": "string",
      "FilePathFilters": [
        "string"
      ],
      "GitCredentialId": "string",
      "GitCredentialType": "string",
      "GitHubConnectionId": "string",
      "Name": "string",
      "RepositoryUri": "string",
      "StepPackageInputsReferenceId": "string"
    }
  ],
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Packages": [
    {
      "AcquisitionLocation": "string",
      "FeedId": "string",
      "Id": "string",
      "Name": "string",
      "PackageId": "string",
      "Properties": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "StepPackageInputsReferenceId": "string",
      "Version": "string"
    }
  ],
  "Parameters": [
    {
      "DefaultValue": {
        "IsSensitive": true,
        "SensitiveValue": {},
        "Value": "string"
      },
      "DisplaySettings": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "HelpText": "string",
      "Id": "string",
      "Label": "string",
      "Name": "string"
    }
  ],
  "Properties": {
    "additionalProp1": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp2": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    },
    "additionalProp3": {
      "IsSensitive": true,
      "SensitiveValue": {
        "HasValue": true,
        "Hint": "string",
        "NewValue": "string"
      },
      "Value": "string"
    }
  },
  "SpaceId": "string",
  "Version": 0
}

Get the logo associated with the community step template

GET /api/communityactiontemplates/{id}/logo

Path Parameters

id string (required)
The ID of the community action template.

Response

200 — Success

"string"