adobe-experience-manager-sites

Adobe AEM Sites - content fragments, models, variations, versions, tags, and workflows

Server path: /adobe-experience-manager-sites | Type: Application | PCID required: Yes

Tools

Tool	Description
adobe_experience_manager_sites_batch_create	Create a batch request
adobe_experience_manager_sites_batch_get	Retrieve the status of a batch request
adobe_experience_manager_sites_batch_list	List batch requests
adobe_experience_manager_sites_fragment_add_tags_to_content_fragment	Add tags to a Content Fragment
adobe_experience_manager_sites_fragment_delete_tags_from_content_fragment	Delete the Tags applied to a Content Fragment
adobe_experience_manager_sites_fragment_replace_tags_from_content_fragment	Replace the Tags applied to a Content Fragment
adobe_experience_manager_sites_fragment_variations_delete_variation	Delete a Content Fragment Variation
adobe_experience_manager_sites_fragment_variations_update_variation	Edit a Content Fragment Variation
adobe_experience_manager_sites_fragments_add_tags_to_variation	Add Tags to a Content Fragment Variation
adobe_experience_manager_sites_fragments_change_model	Change the model of a Content Fragment
adobe_experience_manager_sites_fragments_copy	Copy a Content Fragment
adobe_experience_manager_sites_fragments_copy_tree	Copy a Content Fragment
adobe_experience_manager_sites_fragments_create_fragment	Create a Content Fragment
adobe_experience_manager_sites_fragments_create_variation_for_fragment	Create a Content Fragment Variation
adobe_experience_manager_sites_fragments_create_versions_for_fragment	Create a Version for a Content Fragment
adobe_experience_manager_sites_fragments_delete_and_unpublish_fragment	Delete and unpublish Content Fragment
adobe_experience_manager_sites_fragments_delete_fragment	Delete a Content Fragment
adobe_experience_manager_sites_fragments_delete_tags_from_variation	Delete the Tags applied to a Content Fragment Variation
adobe_experience_manager_sites_fragments_delete_version	Delete a Content Fragment Version
adobe_experience_manager_sites_fragments_find_and_replace	Find and replace text in Content Fragments
adobe_experience_manager_sites_fragments_fragment_referenced_by	Get the parent references of a Content Fragment
adobe_experience_manager_sites_fragments_fully_update_fragment	Update all mutable properties of a Content Fragment
adobe_experience_manager_sites_fragments_get_domain	Get the domain URL matching the AEM tier environment provided.
adobe_experience_manager_sites_fragments_get_fragment	Get a Content Fragment
adobe_experience_manager_sites_fragments_get_fragment_references	Get the references of a Content Fragment
adobe_experience_manager_sites_fragments_get_fragment_references_tree	Get the references of a Content Fragment as a list
adobe_experience_manager_sites_fragments_get_fragment_variation_references	Get the tree of references contained in a Content Fragment Variation
adobe_experience_manager_sites_fragments_get_fragment_version	Get a Version for a Content Fragment
adobe_experience_manager_sites_fragments_get_fragments	List all Content Fragments
adobe_experience_manager_sites_fragments_get_languages	Get the available language(s) for creating Language Copies for a given Content Fragment path
adobe_experience_manager_sites_fragments_get_model	Get the model of a Content Fragment
adobe_experience_manager_sites_fragments_get_permissions	Get the current user’s permissions on a Content Fragment
adobe_experience_manager_sites_fragments_get_preview_urlfor_fragment	Get the preview URLs for a Content Fragment
adobe_experience_manager_sites_fragments_get_tags_from_fragment	Get the Tags applied to a Content Fragment
adobe_experience_manager_sites_fragments_get_tags_from_variation	Get the Tags applied to a Content Fragment Variation
adobe_experience_manager_sites_fragments_get_translations	Get the locales and language copies of a Content Fragment
adobe_experience_manager_sites_fragments_get_variation_for_fragment	Get a Variation for a Content Fragment
adobe_experience_manager_sites_fragments_get_variations_for_fragment	List a Content Fragment’s Variations
adobe_experience_manager_sites_fragments_get_versions_for_fragment	List a Content Fragment’s Versions
adobe_experience_manager_sites_fragments_permissions	Get the current’s user permissions on a list of resources
adobe_experience_manager_sites_fragments_publish	Publish Content Fragments
adobe_experience_manager_sites_fragments_referenced_by	Get the parent references of a given list of resources
adobe_experience_manager_sites_fragments_replace_tags_from_variation	Replace the Tags applied to a Content Fragment Variation
adobe_experience_manager_sites_fragments_restore_version	Restore a Content Fragment Version
adobe_experience_manager_sites_fragments_retrieve_model_uischema	Get the UI schema associated with the Content Fragment Model of a Content Fragment
adobe_experience_manager_sites_fragments_scheduled_publication_status	Get the scheduled publication status for a Content Fragment
adobe_experience_manager_sites_fragments_scheduled_publication_status_multiple_fragments	Get the scheduled publication status for a list of Content Fragment IDs
adobe_experience_manager_sites_fragments_search	Search API for Content Fragments based on various Search Criteria.
adobe_experience_manager_sites_fragments_translations	Get the locales and language copies of a given list of resources
adobe_experience_manager_sites_fragments_update_checkout_state	Update checkout state of a Content Fragment
adobe_experience_manager_sites_fragments_update_fragment	Edit a Content Fragment
adobe_experience_manager_sites_graph_ql_get	GraphQL GET request
adobe_experience_manager_sites_graph_ql_post	GraphQL POST request
adobe_experience_manager_sites_models_add_tags_to_content_fragment_model	Add Tags to a Content Fragment Model
adobe_experience_manager_sites_models_copy	Copy a Content Fragment Model
adobe_experience_manager_sites_models_create_model	Create a Content Fragment Model
adobe_experience_manager_sites_models_create_or_update_uischema	Update the existing UI schema associated with a Content Fragment Model
adobe_experience_manager_sites_models_delete_model	Delete a Content Fragment Model
adobe_experience_manager_sites_models_delete_tags_from_content_fragment_model	Delete the Tags applied to a Content Fragment Model
adobe_experience_manager_sites_models_get_model	Get a Content Fragment Model
adobe_experience_manager_sites_models_get_models	List all Content Fragment Models
adobe_experience_manager_sites_models_get_tags_from_content_fragment_model	Get the Tags applied to a Content Fragment Model
adobe_experience_manager_sites_models_publish	Publish Content Fragment Models
adobe_experience_manager_sites_models_replace_tags_from_content_fragment_model	Replace the Tags applied to a Content Fragment Model
adobe_experience_manager_sites_models_retrieve_uischema	Get the UI schema associated with the Content Fragment Model
adobe_experience_manager_sites_models_scheduled_publication_status_multiple_models	Get the scheduled publication status for a list of Content Fragment Models
adobe_experience_manager_sites_models_search	Search API for Content Fragment Models based on various Search Criteria.
adobe_experience_manager_sites_models_update_model	Edit a Content Fragment Model
adobe_experience_manager_sites_permissions	Get the current’s user permissions on a list of resources
adobe_experience_manager_sites_workflows_get_workflow	Get a Workflow
adobe_experience_manager_sites_workflows_get_workflows	List Workflows
adobe_experience_manager_sites_workflows_start	Start a workflow

---

adobe_experience_manager_sites_batch_create

Create a batch request

Parameters:

Parameter	Type	Required	Default	Description
requests	object[]	Yes	—	The requests value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "requests": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "The path part of the request URL."
          },
          "method": {
            "type": "string",
            "enum": [
              "POST",
              "PUT",
              "DELETE",
              "PATCH"
            ],
            "description": "The HTTP method of the request."
          },
          "headers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name."
                },
                "value": {
                  "type": "string",
                  "description": "The value."
                }
              }
            },
            "description": "The headers value"
          },
          "queryParameters": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name."
                },
                "value": {
                  "type": "string",
                  "description": "The value."
                }
              }
            },
            "description": "Query Parameters"
          },
          "body": {
            "type": "object",
            "description": "The body value"
          }
        },
        "required": [
          "path",
          "method"
        ]
      },
      "description": "The requests value"
    }
  },
  "required": [
    "PCID",
    "requests"
  ]
}

---

adobe_experience_manager_sites_batch_get

Retrieve the status of a batch request

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the Batch Request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the Batch Request"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_experience_manager_sites_batch_list

List batch requests

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
jobStatus	string	No	—	If this optional parameter is provided, the batch requests will be filtered based on their status.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "jobStatus": {
      "type": "string",
      "description": "If this optional parameter is provided, the batch requests will be filtered based on their status.",
      "enum": [
        "FINISHED",
        "FINISHED_SUCCESS",
        "FINISHED_FAILURE",
        "UNFINISHED",
        "UNFINISHED_ACTIVE",
        "UNFINISHED_QUEUED"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_fragment_add_tags_to_content_fragment

Add tags to a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
tags	string[]	Yes	—	List of tag IDs to be added to the Content Fragment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag IDs to be added to the Content Fragment"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "tags"
  ]
}

---

adobe_experience_manager_sites_fragment_delete_tags_from_content_fragment

Delete the Tags applied to a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_fragment_replace_tags_from_content_fragment

Replace the Tags applied to a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
tags	string[]	Yes	—	List of tag IDs to be added to the Content Fragment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag IDs to be added to the Content Fragment"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match",
    "tags"
  ]
}

---

adobe_experience_manager_sites_fragment_variations_delete_variation

Delete a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
name	string	Yes	—	The name of the Variation
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
unlinkReferences	boolean	No	—	Optional boolean parameter, if set to true, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is false.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the Variation"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "unlinkReferences": {
      "type": "boolean",
      "description": "Optional boolean parameter, if set to `true`, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is `false`."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_fragment_variations_update_variation

Edit a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
name	string	Yes	—	The name of the Variation
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
body	object[]	Yes	—	JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The application/json-patch+json media type is used to identify such patch documents. For more details check RFC 6902.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the Variation"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "op": {
            "type": "string",
            "enum": [
              "add",
              "copy",
              "move",
              "remove",
              "replace",
              "test"
            ],
            "description": "The operation to perform"
          },
          "path": {
            "type": "string",
            "description": "A JSON Pointer (RFC 6901) referencing the target location"
          },
          "value": {
            "description": "The value to add/replace/test (required for add, replace, test operations)"
          },
          "from": {
            "type": "string",
            "description": "A JSON Pointer referencing the source location (required for copy and move operations)"
          }
        },
        "required": [
          "op",
          "path"
        ]
      },
      "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents.  For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name",
    "If-Match",
    "body"
  ]
}

---

adobe_experience_manager_sites_fragments_add_tags_to_variation

Add Tags to a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
name	string	Yes	—	The name of the variation for which the tags are retrieved.
tags	string[]	Yes	—	List of tag IDs to be added to the Content Fragment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the variation for which the tags are retrieved."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag IDs to be added to the Content Fragment"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name",
    "tags"
  ]
}

---

adobe_experience_manager_sites_fragments_change_model

Change the model of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
modelId	string	Yes	—	Defines a base64url with no padding encoded ID.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "modelId": {
      "type": "string",
      "description": "Defines a `base64url` with no padding encoded ID."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match",
    "modelId"
  ]
}

---

adobe_experience_manager_sites_fragments_copy

Copy a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	The unique identifier of the Content Fragment to be copied.
name	string	No	—	This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value. When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict.
parentPath	string	Yes	—	The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error. This path should start with /content/dam or should be relative to the /content/dam folder.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "The unique identifier of the Content Fragment to be copied."
    },
    "name": {
      "type": "string",
      "description": "This property allows you to specify a new name for the resource being copied.  When a value is not provided the original name of the resource will be used. In case of resource conflicts in the  destination folder, the server will automatically generate an alternative resource name based on the provided value.  When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict."
    },
    "parentPath": {
      "type": "string",
      "description": "The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error.  This path should start with `/content/dam` or should be relative to the `/content/dam` folder."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "parentPath"
  ]
}

---

adobe_experience_manager_sites_fragments_copy_tree

Copy a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	The unique identifier of the Content Fragment to be copied.
copyReferencesToMainFolder	boolean	No	—	If set to true, the references of the Content Fragment will be copied under the same folder as the main Content Fragment. If set to false, the references will be copied under their original folders.
name	string	No	—	This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value. When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict.
parentPath	string	Yes	—	The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error. This path should start with /content/dam or should be relative to the /content/dam folder.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "The unique identifier of the Content Fragment to be copied."
    },
    "copyReferencesToMainFolder": {
      "type": "boolean",
      "description": "If set to true, the references of the Content Fragment will be copied under the same folder as the main Content Fragment. If set to false, the references will be copied under their original folders."
    },
    "name": {
      "type": "string",
      "description": "This property allows you to specify a new name for the resource being copied.  When a value is not provided the original name of the resource will be used. In case of resource conflicts in the  destination folder, the server will automatically generate an alternative resource name based on the provided value.  When a value is provided and a conflict exists in the destination folder, the caller will have to explicitly solve the conflict."
    },
    "parentPath": {
      "type": "string",
      "description": "The folder to which the Content Fragment should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error.  This path should start with `/content/dam` or should be relative to the `/content/dam` folder."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "parentPath"
  ]
}

---

adobe_experience_manager_sites_fragments_create_fragment

Create a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
description	string	No	—	The description of the new Content Fragment.
fields	object[]	No	—	Data needed for populating the content fragment fields defined in the model
modelId	string	Yes	—	Defines a base64url with no padding encoded ID.
name	string	No	—	Optional parameter that represents the name used when storing the new Content Fragment. When missing, the value will be derived by the server from the title value.
parentPath	string	Yes	—	The folder path where the new Content Fragment will be created, relative to /content/dam. Examples: - /wknd-shared/en/adventures creates fragment at /content/dam/wknd-shared/en/adventures - /my-site/content creates fragment at /content/dam/my-site/content
title	string	Yes	—	The title of the new Content Fragment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": "string",
      "description": "The description of the new Content Fragment."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the field."
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "long-text",
              "number",
              "float-number",
              "date-time",
              "date",
              "time",
              "boolean",
              "enumeration",
              "tag",
              "content-fragment",
              "content-reference",
              "json"
            ],
            "description": "Type of data stored in the field."
          },
          "multiple": {
            "type": "boolean",
            "description": "Whether the field has multiple values."
          },
          "locked": {
            "type": "boolean",
            "description": "If set to true, the field cannot be edited.  In case of live copies, the field inherits its value from the source content fragment and cannot be edited."
          }
        },
        "required": [
          "name",
          "type"
        ]
      },
      "description": "Data needed for populating the content fragment fields defined in the model"
    },
    "modelId": {
      "type": "string",
      "description": "Defines a `base64url` with no padding encoded ID."
    },
    "name": {
      "type": "string",
      "description": "Optional parameter that represents the name used when storing the new Content Fragment. When missing, the value will be derived by the server from the `title` value."
    },
    "parentPath": {
      "type": "string",
      "description": "The folder path where the new Content Fragment will be created, relative to `/content/dam`.  Examples: - `/wknd-shared/en/adventures` creates fragment at `/content/dam/wknd-shared/en/adventures` - `/my-site/content` creates fragment at `/content/dam/my-site/content`"
    },
    "title": {
      "type": "string",
      "description": "The title of the new Content Fragment."
    }
  },
  "required": [
    "PCID",
    "modelId",
    "parentPath",
    "title"
  ]
}

---

adobe_experience_manager_sites_fragments_create_variation_for_fragment

Create a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
description	string	No	—	Variation description.
title	string	Yes	—	Variation title

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "description": {
      "type": "string",
      "description": "Variation description."
    },
    "title": {
      "type": "string",
      "description": "Variation title"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "title"
  ]
}

---

adobe_experience_manager_sites_fragments_create_versions_for_fragment

Create a Version for a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
comment	string	No	—	Content Fragment version comment.
label	string	No	—	Content Fragment version label.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "comment": {
      "type": "string",
      "description": "Content Fragment version comment."
    },
    "label": {
      "type": "string",
      "description": "Content Fragment version label."
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_delete_and_unpublish_fragment

Delete and unpublish Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
unlinkReferences	boolean	No	—	An optional boolean parameter. When set to true, the references to the deleted fragment are removed from all referencing fragments. By default, the value of this query parameter is true.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "unlinkReferences": {
      "type": "boolean",
      "description": "An optional boolean parameter. When set to `true`, the references to the deleted fragment are removed from all referencing fragments. By default, the value of this query parameter is `true`."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_fragments_delete_fragment

Delete a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
unlinkReferences	boolean	No	—	Optional boolean parameter, if set to true, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is false.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "unlinkReferences": {
      "type": "boolean",
      "description": "Optional boolean parameter, if set to `true`, the references to the deleted fragment will be removed from the referencing fragments. By default, the value of this query parameter is `false`."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_fragments_delete_tags_from_variation

Delete the Tags applied to a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
name	string	Yes	—	The name of the variation for which the tags are retrieved.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the variation for which the tags are retrieved."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_fragments_delete_version

Delete a Content Fragment Version

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
versionId	string	Yes	—	Content Fragment Version unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "versionId": {
      "type": "string",
      "description": "Content Fragment Version unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "versionId",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_fragments_find_and_replace

Find and replace text in Content Fragments

Parameters:

Parameter	Type	Required	Default	Description
dryRun	boolean	Yes	—	Find And Replace operation runs in simulation mode, we only get simulated results and no change is committed in JCR.
fieldNames	string[]	No	—	An optional list of text and long text field names. If provided, it will be used to restrict the Find And Replace operation to those specific fields within the Content Fragments. If not provided, the operation will be performed on all text and long text fields.
find	string	Yes	—	String we want to replace in all TEXT fields in selected Content Fragments
ignoreErrors	boolean	Yes	—	True means that we want replacement taking place for all cases when Replacement would be successful and do nothing for cases in error.
isCaseSensitive	boolean	No	—	True means that we want to perform case sensitive search.
matchExactWord	boolean	No	—	A flag indicating whether to only consider the exact matches of the find String When set to true (optional), the replacement will occur only for occurrences of the find String that are entire words, excluding parts of compound words. When set to false (default), the replacement will happen for any occurrence of the find String, including within compound words.
paths	string[]	Yes	—	The list of Content Fragments paths on which Find And Replace operation is performed.
replace	string	Yes	—	Replacement string.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dryRun": {
      "type": "boolean",
      "description": "Find And Replace operation runs in simulation  mode, we only get simulated results and no change is committed in JCR."
    },
    "fieldNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An optional list of text and long text field names. If provided, it will be used to restrict the Find And Replace operation to those specific fields within the Content Fragments. If not provided, the operation will be performed on all text and long text fields."
    },
    "find": {
      "type": "string",
      "description": "String we want to replace in all TEXT fields in selected Content Fragments"
    },
    "ignoreErrors": {
      "type": "boolean",
      "description": "True means that we want replacement taking place for all cases when Replacement would be successful and do nothing for cases in error."
    },
    "isCaseSensitive": {
      "type": "boolean",
      "description": "True means that we want to perform case sensitive search."
    },
    "matchExactWord": {
      "type": "boolean",
      "description": "A flag indicating whether to only consider the exact matches of the `find` String When set to `true` (optional), the replacement will occur only for occurrences of the `find` String that are entire words, excluding parts of compound words. When set to `false` (default), the replacement will happen for any occurrence of the `find` String, including within compound words."
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of Content Fragments paths on which Find And Replace operation is performed."
    },
    "replace": {
      "type": "string",
      "description": "Replacement string."
    }
  },
  "required": [
    "PCID",
    "dryRun",
    "find",
    "ignoreErrors",
    "paths",
    "replace"
  ]
}

---

adobe_experience_manager_sites_fragments_fragment_referenced_by

Get the parent references of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_fully_update_fragment

Update all mutable properties of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
description	string	No	—	Updated description of the Content Fragment.
fields	object[]	No	—	Updated fields on the Content Fragment.
title	string	Yes	—	Updated title of the Content Fragment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "description": {
      "type": "string",
      "description": "Updated description of the  Content Fragment."
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the field."
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "long-text",
              "number",
              "float-number",
              "date-time",
              "date",
              "time",
              "boolean",
              "enumeration",
              "tag",
              "content-fragment",
              "content-reference",
              "json"
            ],
            "description": "Type of data stored in the field."
          },
          "multiple": {
            "type": "boolean",
            "description": "Whether the field has multiple values."
          },
          "locked": {
            "type": "boolean",
            "description": "If set to true, the field cannot be edited.  In case of live copies, the field inherits its value from the source content fragment and cannot be edited."
          }
        },
        "required": [
          "name",
          "type"
        ]
      },
      "description": "Updated fields on the Content Fragment."
    },
    "title": {
      "type": "string",
      "description": "Updated title of the  Content Fragment."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match",
    "title"
  ]
}

---

adobe_experience_manager_sites_fragments_get_domain

Get the domain URL matching the AEM tier environment provided.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_fragments_get_fragment

Get a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-None-Match	string	No	—	The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110.
references	string	No	—	This parameter defines how references will be retrieved for Content Fragments. The following options are available: * direct - only direct references will be collected; they will not be hydrated; * direct-hydrated - only direct references will be collected; they will be fully hydrated; * all - all references up to the maximum allowed depth will be collected; they will not be hydrated; * all-hydrated - all references up to the maximum allowed depth will be collected; they will be fully hydrated * none - no references will be collected Non-hydrated responses will only include the properties defined by the BaseReference type when embedding references. Hydrated responses are defined by each implementation of the BaseReference type. In particular, for Content Fragment references the response will include the fragment’s fields, variations, tags.
locale	string	No	—	An optional parameter that specifies the locale of the Content Fragment, using a language and country code (e.g. en_us). If provided, the corresponding language copy of the Content Fragment will be returned if available. If not available, a 404 error will be returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-None-Match": {
      "type": "string",
      "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
    },
    "references": {
      "type": "string",
      "description": "This parameter defines how references will be retrieved for Content Fragments. The following options are available:   * `direct` - only direct references will be collected; they will not be hydrated;   * `direct-hydrated` - only direct references will be collected; they will be fully hydrated;   * `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated;   * `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated   * `none` - no references will be collected  Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references.  Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags.",
      "enum": [
        "direct",
        "direct-hydrated",
        "all",
        "all-hydrated",
        "none"
      ]
    },
    "locale": {
      "type": "string",
      "description": "An optional parameter that specifies the locale of the Content Fragment, using a language and country code (e.g. en_us).  If provided, the corresponding language copy of the Content Fragment will be returned if available. If not available, a 404 error will be returned."
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_fragment_references

Get the references of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Resource unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Resource unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_fragment_references_tree

Get the references of a Content Fragment as a list

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Resource unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Resource unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_fragment_variation_references

Get the tree of references contained in a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Resource unique identifier
name	string	Yes	—	The name of the variation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Resource unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the variation"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name"
  ]
}

---

adobe_experience_manager_sites_fragments_get_fragment_version

Get a Version for a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
versionId	string	Yes	—	Content Fragment Version unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "versionId": {
      "type": "string",
      "description": "Content Fragment Version unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "versionId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_fragments

List all Content Fragments

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
path	string	No	—	Optional UTF-8 encoded parameter to specify a path where to start looking for content fragments.
references	string	No	—	When the path query parameter identifies a Content Fragment, this parameter allows controlling the way the references are retrieved for that fragment. When this parameter is missing, the references will not be populated. The following options are available: * direct - only direct references will be collected; they will not be hydrated; * direct-hydrated - only direct references will be collected; they will be fully hydrated; * all - all references up to the maximum allowed depth will be collected; they will not be hydrated; * all-hydrated - all references up to the maximum allowed depth will be collected; they will be fully hydrated * none - no references will be collected Non-hydrated responses will only include the properties defined by the BaseReference type when embedding references. Hydrated responses are defined by each implementation of the BaseReference type. In particular, for Content Fragment references the response will include the fragment’s fields, variations, tags.
projection	string	No	—	If this optional parameter is provided and its value is ‘summary’, the fragments in the response will contain only the required properties.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "path": {
      "type": "string",
      "description": "Optional UTF-8 encoded parameter to specify a path where to start looking for content fragments."
    },
    "references": {
      "type": "string",
      "description": "When the `path` query parameter identifies a Content Fragment, this parameter allows controlling the way the references are retrieved for that fragment. When this parameter is missing, the references will not be populated.  The following options are available:   * `direct` - only direct references will be collected; they will not be hydrated;   * `direct-hydrated` - only direct references will be collected; they will be fully hydrated;   * `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated;   * `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated   * `none` - no references will be collected  Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references.  Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags.",
      "enum": [
        "direct",
        "direct-hydrated",
        "all",
        "all-hydrated",
        "none"
      ]
    },
    "projection": {
      "type": "string",
      "description": "If this optional parameter is provided and its value is 'summary', the fragments in the response will contain only the required properties.",
      "enum": [
        "minimal",
        "summary",
        "full"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_fragments_get_languages

Get the available language(s) for creating Language Copies for a given Content Fragment path

Parameters:

Parameter	Type	Required	Default	Description
path	string	Yes	—	Required UTF-8 encoded parameter to specify a Content Fragment path for which to retrieve the available language roots.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "path": {
      "type": "string",
      "description": "Required UTF-8 encoded parameter to specify a Content Fragment path for which to retrieve the available language roots."
    }
  },
  "required": [
    "PCID",
    "path"
  ]
}

---

adobe_experience_manager_sites_fragments_get_model

Get the model of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_permissions

Get the current user’s permissions on a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_preview_urlfor_fragment

Get the preview URLs for a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_tags_from_fragment

Get the Tags applied to a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_tags_from_variation

Get the Tags applied to a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
name	string	Yes	—	The name of the variation for which the tags are retrieved.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the variation for which the tags are retrieved."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name"
  ]
}

---

adobe_experience_manager_sites_fragments_get_translations

Get the locales and language copies of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_variation_for_fragment

Get a Variation for a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
name	string	Yes	—	The name of the Variation
references	string	No	—	This parameter defines how references will be retrieved for Content Fragments. The following options are available: * direct - only direct references will be collected; they will not be hydrated; * direct-hydrated - only direct references will be collected; they will be fully hydrated; * all - all references up to the maximum allowed depth will be collected; they will not be hydrated; * all-hydrated - all references up to the maximum allowed depth will be collected; they will be fully hydrated * none - no references will be collected Non-hydrated responses will only include the properties defined by the BaseReference type when embedding references. Hydrated responses are defined by each implementation of the BaseReference type. In particular, for Content Fragment references the response will include the fragment’s fields, variations, tags.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the Variation"
    },
    "references": {
      "type": "string",
      "description": "This parameter defines how references will be retrieved for Content Fragments. The following options are available:   * `direct` - only direct references will be collected; they will not be hydrated;   * `direct-hydrated` - only direct references will be collected; they will be fully hydrated;   * `all` - all references up to the maximum allowed depth will be collected; they will not be hydrated;   * `all-hydrated` - all references up to the maximum allowed depth will be collected; they will be fully hydrated   * `none` - no references will be collected  Non-hydrated responses will only include the properties defined by the `BaseReference` type when embedding references.  Hydrated responses are defined by each implementation of the `BaseReference` type. In particular, for Content Fragment references the response will include the fragment's fields, variations, tags.",
      "enum": [
        "direct",
        "direct-hydrated",
        "all",
        "all-hydrated",
        "none"
      ]
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name"
  ]
}

---

adobe_experience_manager_sites_fragments_get_variations_for_fragment

List a Content Fragment’s Variations

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_get_versions_for_fragment

List a Content Fragment’s Versions

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_permissions

Get the current’s user permissions on a list of resources

Parameters:

Parameter	Type	Required	Default	Description
paths	string[]	Yes	—	The list of resource paths - Content Fragments, Content Fragment Models and Folder - for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the /content/dam directory, the Content Fragment Models within the /conf directory, and the Folders could be within either /content/dam or the /conf directory.
preferredPermissions	string[]	No	—	The preferred list of permissions to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of resource paths - Content Fragments, Content Fragment Models and Folder -  for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the `/content/dam` directory, the Content Fragment Models within the `/conf` directory, and the Folders could be within either `/content/dam` or the `/conf` directory."
    },
    "preferredPermissions": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "READ",
          "EDIT",
          "RENAME",
          "DELETE",
          "PUBLISH",
          "CREATE_CONTENT_FRAGMENT",
          "CREATE_CONTENT_FRAGMENT_MODEL",
          "CHECKIN",
          "CHECKOUT"
        ]
      },
      "description": "The preferred list of permissions to return."
    }
  },
  "required": [
    "PCID",
    "paths"
  ]
}

---

adobe_experience_manager_sites_fragments_publish

Publish Content Fragments

Parameters:

Parameter	Type	Required	Default	Description
agentId	string	No	—	The agent id used for publishing the content fragments.
filterReferencesByStatus	object[]	No	—	Provides the option to select which references should be included in the publication based on their status. When a status is selected (e.g., DRAFT), references with that status will be published along with the content fragment. Multiple statuses can be selected to include references with any of those statuses. If no option is selected, no references will be published regardless of their status.
ids	string[]	No	—	The list of content fragment IDs.
paths	string[]	No	—	The list of content fragment paths.
preValidationSeconds	integer	No	—	If this property is provided, a validation of all the fragments contained in the payload together with all their references will be attempted. This validation only applies when filterReferencesByStatus is populated, as it validates the complete references tree based on the selected reference statuses. Without filterReferencesByStatus, there are no references to validate, making this property ineffective. The cutoff limit for this validation will be the provided value in seconds. The fragments from the payload which will be found invalid in the allocated interval will be removed from the publish operation and their status will be returned as such in the response. In case there are no valid fragments in the payload after the validation, the workflow will not be started.
scheduledTime	integer	No	—	The scheduled time as an epoch timestamp.
workflowModelId	string	No	—	The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model /etc/workflow/models/scheduled_activation_with_references for publishing content fragments including their references.
workflowTitle	string	No	—	A freely defined non-empty string used to identify the workflow when it executes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "agentId": {
      "type": "string",
      "description": "The agent id used for publishing the content fragments."
    },
    "filterReferencesByStatus": {
      "type": "array",
      "items": {
        "enum": [
          "DRAFT",
          "UNPUBLISHED",
          "MODIFIED"
        ]
      },
      "description": "Provides the option to select which references should be included in the publication based on their status. When a status is selected (e.g., `DRAFT`), references with that status will be published along with the content fragment. Multiple statuses can be selected to include references with any of those statuses. If no option is selected, no references will be published regardless of their status."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The list of content fragment IDs."
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of content fragment paths."
    },
    "preValidationSeconds": {
      "type": "integer",
      "description": "If this property is provided, a validation of all the fragments contained in the payload together with all their  references will be attempted.  This validation only applies when `filterReferencesByStatus` is populated,  as it validates the complete references tree based on the selected reference statuses. Without `filterReferencesByStatus`, there are no references to validate, making this property ineffective. The cutoff limit for this validation will be the provided value in seconds.  The fragments from the payload which will be found invalid in the allocated interval will be removed from the  publish operation and their status will be returned as such in the response. In case there are no valid fragments in the payload after the validation, the workflow will not be started."
    },
    "scheduledTime": {
      "type": "integer",
      "description": "The scheduled time as an epoch timestamp."
    },
    "workflowModelId": {
      "type": "string",
      "description": "The workflow model id used for initiating the workflow instance to handle the publication.  AEM provides the designated model `/etc/workflow/models/scheduled_activation_with_references` for publishing  content fragments including their references."
    },
    "workflowTitle": {
      "type": "string",
      "description": "A freely defined non-empty string used to identify the workflow when it executes."
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_fragments_referenced_by

Get the parent references of a given list of resources

Parameters:

Parameter	Type	Required	Default	Description
paths	string[]	Yes	—	The list of Content Fragment paths for which to retrieve the back references.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of Content Fragment paths for which to retrieve the back references."
    }
  },
  "required": [
    "PCID",
    "paths"
  ]
}

---

adobe_experience_manager_sites_fragments_replace_tags_from_variation

Replace the Tags applied to a Content Fragment Variation

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
name	string	Yes	—	The name of the variation for which the tags are retrieved.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
tags	string[]	Yes	—	List of tag IDs to be added to the Content Fragment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "name": {
      "type": "string",
      "description": "The name of the variation for which the tags are retrieved."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag IDs to be added to the Content Fragment"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "name",
    "If-Match",
    "tags"
  ]
}

---

adobe_experience_manager_sites_fragments_restore_version

Restore a Content Fragment Version

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
versionId	string	Yes	—	Content Fragment Version unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "versionId": {
      "type": "string",
      "description": "Content Fragment Version unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "versionId"
  ]
}

---

adobe_experience_manager_sites_fragments_retrieve_model_uischema

Get the UI schema associated with the Content Fragment Model of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
X-Adobe-Accept-Unsupported-API	integer	Yes	—	The X-Adobe-Accept-Unsupported-API request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.
fragmentId	string	Yes	—	Content Fragment unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "X-Adobe-Accept-Unsupported-API": {
      "type": "integer",
      "description": "The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.",
      "enum": [
        1
      ]
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    }
  },
  "required": [
    "PCID",
    "X-Adobe-Accept-Unsupported-API",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_scheduled_publication_status

Get the scheduled publication status for a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Resource unique identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Resource unique identifier"
    }
  },
  "required": [
    "PCID",
    "fragmentId"
  ]
}

---

adobe_experience_manager_sites_fragments_scheduled_publication_status_multiple_fragments

Get the scheduled publication status for a list of Content Fragment IDs

Parameters:

Parameter	Type	Required	Default	Description
ids	string[]	No	—	The list of Content Fragment IDs.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "description": "The list of Content Fragment IDs."
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_fragments_search

Search API for Content Fragments based on various Search Criteria.

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
query	string	Yes	—	The query parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded.
projection	string	No	—	If this optional parameter is provided and its value is ‘summary’, the fragments in the response will contain only the required properties.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "query": {
      "type": "string",
      "description": "The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded."
    },
    "projection": {
      "type": "string",
      "description": "If this optional parameter is provided and its value is 'summary', the fragments in the response will contain only the required properties.",
      "enum": [
        "minimal",
        "summary",
        "full"
      ]
    }
  },
  "required": [
    "PCID",
    "query"
  ]
}

---

adobe_experience_manager_sites_fragments_translations

Get the locales and language copies of a given list of resources

Parameters:

Parameter	Type	Required	Default	Description
paths	string[]	Yes	—	The list of paths.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of paths."
    }
  },
  "required": [
    "PCID",
    "paths"
  ]
}

---

adobe_experience_manager_sites_fragments_update_checkout_state

Update checkout state of a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
checkedOut	boolean	Yes	—	Indicates whether the fragment should be checked out (true) or checked in (false). - true: Checks out the fragment, creating an exclusive lock for the current user - false: Checks in the fragment, removing the exclusive lock

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "checkedOut": {
      "type": "boolean",
      "description": "Indicates whether the fragment should be checked out (true) or checked in (false). - `true`: Checks out the fragment, creating an exclusive lock for the current user - `false`: Checks in the fragment, removing the exclusive lock"
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match",
    "checkedOut"
  ]
}

---

adobe_experience_manager_sites_fragments_update_fragment

Edit a Content Fragment

Parameters:

Parameter	Type	Required	Default	Description
fragmentId	string	Yes	—	Content Fragment unique identifier
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
references	string	No	—	An optional parameter that defines how references should be handled when patching the Content Fragment.
body	object[]	Yes	—	JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The application/json-patch+json media type is used to identify such patch documents. For more details check RFC 6902.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fragmentId": {
      "type": "string",
      "description": "Content Fragment unique identifier"
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "references": {
      "type": "string",
      "description": "An optional parameter that defines how references should be handled when patching the Content Fragment.",
      "enum": [
        "none",
        "direct",
        "direct-hydrated"
      ]
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "op": {
            "type": "string",
            "enum": [
              "add",
              "copy",
              "move",
              "remove",
              "replace",
              "test"
            ],
            "description": "The operation to perform"
          },
          "path": {
            "type": "string",
            "description": "A JSON Pointer (RFC 6901) referencing the target location"
          },
          "value": {
            "description": "The value to add/replace/test (required for add, replace, test operations)"
          },
          "from": {
            "type": "string",
            "description": "A JSON Pointer referencing the source location (required for copy and move operations)"
          }
        },
        "required": [
          "op",
          "path"
        ]
      },
      "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents.  For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)."
    }
  },
  "required": [
    "PCID",
    "fragmentId",
    "If-Match",
    "body"
  ]
}

---

adobe_experience_manager_sites_graph_ql_get

GraphQL GET request

Parameters:

Parameter	Type	Required	Default	Description
query	string	Yes	—	GraphQL query string
variables	string	No	—	Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query are passed like arguments to a function and begin with $.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "query": {
      "type": "string",
      "description": "GraphQL query string"
    },
    "variables": {
      "type": "string",
      "description": "Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query are passed like arguments to a function and begin with `$`."
    }
  },
  "required": [
    "PCID",
    "query"
  ]
}

---

adobe_experience_manager_sites_graph_ql_post

GraphQL POST request

Parameters:

Parameter	Type	Required	Default	Description
query	string	Yes	—	Search query string
variables	object	No	—	Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query and are passed like arguments to a function and begin with $.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "query": {
      "type": "string",
      "description": "Search query string"
    },
    "variables": {
      "type": "object",
      "description": "Variables simplify GraphQL queries by letting you pass data separately. Can be declared after the query and are passed like arguments to a function and begin with `$`."
    }
  },
  "required": [
    "PCID",
    "query"
  ]
}

---

adobe_experience_manager_sites_models_add_tags_to_content_fragment_model

Add Tags to a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the Content Fragment Model.
tags	string[]	Yes	—	List of tag IDs to be added to the Content Fragment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag IDs to be added to the Content Fragment"
    }
  },
  "required": [
    "PCID",
    "id",
    "tags"
  ]
}

---

adobe_experience_manager_sites_models_copy

Copy a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The unique identifier of the Content Fragment Model to be copied.
name	string	No	—	This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the destination folder, the server will automatically generate an alternative resource name based on the provided value.
parentPath	string	Yes	—	The configuration folder to which the Content Fragment Model should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The unique identifier of the Content Fragment Model to be copied."
    },
    "name": {
      "type": "string",
      "description": "This property allows you to specify a new name for the resource being copied. When a value is not provided the original name of the resource will be used. In case of resource conflicts in the  destination folder, the server will automatically generate an alternative resource name based on the provided value."
    },
    "parentPath": {
      "type": "string",
      "description": "The configuration folder to which the Content Fragment Model should be copied. The provided destination path should already exist. If the destination path does not exist, the copy operation will not be performed and the system will return an error."
    }
  },
  "required": [
    "PCID",
    "id",
    "parentPath"
  ]
}

---

adobe_experience_manager_sites_models_create_model

Create a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
dryRun	boolean	No	—	If set to true, this operation allows validating the payload for creating one or more Content Fragment Models before performing the actual creation request. It performs the same validations as the creation process but does not create the models.
configurationFolder	string	No	—	The configuration folder where the models should be created. If both configurationFolder and models.configurationFolder are provided, the latter will take precedence.
locked	boolean	No	—	If the models are locked, then no edits can be performed on them, except for unlocking them. If both locked and models.locked are provided, the latter will take precedence.
models	object[]	No	—	The models value
status	string	No	—	The status of this model. A model is in draft as soon as it’s created, unless the user specifically marks the model as enabled. A model is in disabled state only when a user explicitly disables the model.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "dryRun": {
      "type": "boolean",
      "description": "If set to true, this operation allows validating the payload for creating one or more Content Fragment Models  before performing the actual creation request. It performs the same validations as the creation process but does not create the models."
    },
    "configurationFolder": {
      "type": "string",
      "description": "The configuration folder where the models should be created. If both `configurationFolder` and `models.configurationFolder` are provided, the latter will take precedence."
    },
    "locked": {
      "type": "boolean",
      "description": "If the models are locked, then no edits can be performed on them, except for unlocking them. If both `locked` and `models.locked` are provided, the latter will take precedence."
    },
    "models": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "configurationFolder": {
            "type": "string",
            "description": "The configuration folder where the model should be created."
          },
          "name": {
            "type": "string",
            "description": "A human-readable name for this model."
          },
          "technicalName": {
            "type": "string",
            "description": "Optional technical name used for storing the Content Fragment Model. If omitted, it will be generated from the 'name' property following JCR naming conventions (e.g., using hyphens). This name must adhere to JCR node naming rules. It cannot contain the characters: / : [ ] * | \\t \\r \\n. If a model with the same node name already exists in the target folder, an error will be returned due to the conflict."
          },
          "description": {
            "type": "string",
            "description": "A human-readable description for this model."
          },
          "locked": {
            "type": "boolean",
            "description": "If a model is locked, then no edits can be performed on this model, except for unlocking it."
          },
          "status": {
            "type": "string",
            "enum": [
              "enabled",
              "disabled",
              "draft"
            ],
            "description": "The status of this model. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model."
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "The name of this field."
                },
                "label": {
                  "type": "string",
                  "description": "A label to be used when rendering this field in an editable form. "
                },
                "description": {
                  "type": "string",
                  "description": "A human-readable description for this field. "
                },
                "required": {
                  "type": "boolean",
                  "description": "Defines whether this field is required or optional."
                },
                "multiple": {
                  "type": "boolean",
                  "description": "Defines if this field should store multiple values."
                },
                "minItems": {
                  "type": "integer",
                  "description": "A positive integer number that defines the minimum number of values that can be stored into this field"
                },
                "maxItems": {
                  "type": "integer",
                  "description": "A positive integer number that defines the maximum number of values that can be stored into this field"
                },
                "type": {
                  "type": "string",
                  "description": "Type of data stored in the field."
                },
                "extensionConfig": {
                  "type": "object",
                  "description": "If this field is related to an extension, this object contains the configuration of the field for use by the extension. The values in this object are defined by the extension and can be used to configure the field's behavior or appearance. The values can be primitive types (string, boolean, number) or arrays of primitive types. More information about Content Fragments extensions can be found at <a href=\"https://experienceleague.adobe.com/en/docs/experience-manager-learn/cloud-service/developing/extensibility/ui/content-fragments/overview\">AEM Content Fragments extensibility</a>. "
                }
              }
            },
            "description": "The fields value"
          },
          "previewUrlPattern": {
            "type": "string",
            "format": "url",
            "description": "Preview URL Pattern for the given Model"
          }
        },
        "required": [
          "name"
        ]
      },
      "description": "The models value"
    },
    "status": {
      "type": "string",
      "description": "The status of this model. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model.",
      "enum": [
        "enabled",
        "disabled",
        "draft"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_models_create_or_update_uischema

Update the existing UI schema associated with a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
X-Adobe-Accept-Unsupported-API	integer	Yes	—	The X-Adobe-Accept-Unsupported-API request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.
id	string	Yes	—	The ID of the Content Fragment Model.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
constraints	object[]	No	—	The constraints value
uiSchema	object	No	—	Common base interface for any UI schema element.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "X-Adobe-Accept-Unsupported-API": {
      "type": "integer",
      "description": "The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.",
      "enum": [
        1
      ]
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "constraints": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "if": {
            "type": "object",
            "description": "The operation used to evaluate the rule which doesn't have to be mapped to a specific property  and can be applied to multiple properties at once"
          },
          "then": {
            "type": "object",
            "description": "The operation used to evaluate the rule which doesn't have to be mapped to a specific property  and can be applied to multiple properties at once"
          },
          "else": {
            "type": "object",
            "description": "The operation used to evaluate the rule which doesn't have to be mapped to a specific property  and can be applied to multiple properties at once"
          }
        },
        "required": [
          "if",
          "then"
        ]
      },
      "description": "The constraints value"
    },
    "uiSchema": {
      "type": "object",
      "description": "Common base interface for any UI schema element.",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of UI Schema element",
          "enum": [
            "Control",
            "HorizontalLayout",
            "VerticalLayout",
            "Group",
            "Category",
            "Categorization"
          ]
        },
        "options": {
          "type": "object",
          "description": "Additional options for a UI Schema element. The options which are not defined in this schema must have a name that starts with 'x-'."
        },
        "rule": {
          "type": "object",
          "description": "Rules allow for dynamic aspects for a form, e.g. by hiding or disabling UI schema elements."
        }
      },
      "required": [
        "type"
      ]
    }
  },
  "required": [
    "PCID",
    "X-Adobe-Accept-Unsupported-API",
    "id",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_models_delete_model

Delete a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
If-None-Match	string	No	—	The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110.
id	string	Yes	—	The ID of the Content Fragment Model to retrieve.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "If-None-Match": {
      "type": "string",
      "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model to retrieve."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    }
  },
  "required": [
    "PCID",
    "id",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_models_delete_tags_from_content_fragment_model

Delete the Tags applied to a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the Content Fragment Model.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    }
  },
  "required": [
    "PCID",
    "id",
    "If-Match"
  ]
}

---

adobe_experience_manager_sites_models_get_model

Get a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
If-None-Match	string	No	—	The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110.
id	string	Yes	—	The ID of the Content Fragment Model to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "If-None-Match": {
      "type": "string",
      "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_experience_manager_sites_models_get_models

List all Content Fragment Models

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
projection	string	No	—	This parameter is optional. If set to ‘minimal’, the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to ‘summary’, the Content Fragment Model’s fields will not be populated in the response. If set to ‘full’, the response will include all properties. By default, the value of this query parameter is ‘full’.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "projection": {
      "type": "string",
      "description": "This parameter is optional. If set to 'minimal', the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to 'summary', the Content Fragment Model's fields will not be populated in the response.  If set to 'full', the response will include all properties. By default, the value of this query parameter is 'full'.",
      "enum": [
        "minimal",
        "summary",
        "full"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_models_get_tags_from_content_fragment_model

Get the Tags applied to a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the Content Fragment Model.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

adobe_experience_manager_sites_models_publish

Publish Content Fragment Models

Parameters:

Parameter	Type	Required	Default	Description
agentId	string	No	—	The agent id used for publishing the content fragment models.
filterAllowedModelIdsByStatus	object[]	Yes	—	The status of the referenced models. A model is in draft as soon as it’s created, unless the user specifically marks the model as enabled. A model is in disabled state only when a user explicitly disables the model.
ids	string[]	Yes	—	The list of content fragment model ids.
scheduledTime	integer	No	—	The scheduled time as an epoch timestamp.
workflowModelId	string	No	—	The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model /etc/workflow/models/scheduled_model_activation_with_references for publishing contents including references.
workflowTitle	string	No	—	A freely defined non-empty string used to identify the workflow when it executes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "agentId": {
      "type": "string",
      "description": "The agent id used for publishing the content fragment models."
    },
    "filterAllowedModelIdsByStatus": {
      "type": "array",
      "items": {
        "enum": [
          "ENABLED",
          "DISABLED",
          "DRAFT"
        ]
      },
      "description": "The status of the referenced models. A model is in `draft` as soon as it's created, unless the user specifically marks the model as `enabled`. A model is in `disabled` state only when a user explicitly disables the model."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of content fragment model ids."
    },
    "scheduledTime": {
      "type": "integer",
      "description": "The scheduled time as an epoch timestamp."
    },
    "workflowModelId": {
      "type": "string",
      "description": "The workflow model id used for initiating the workflow instance to handle the publication. AEM provides the designated model `/etc/workflow/models/scheduled_model_activation_with_references` for publishing contents including references."
    },
    "workflowTitle": {
      "type": "string",
      "description": "A freely defined non-empty string used to identify the workflow when it executes."
    }
  },
  "required": [
    "PCID",
    "filterAllowedModelIdsByStatus",
    "ids"
  ]
}

---

adobe_experience_manager_sites_models_replace_tags_from_content_fragment_model

Replace the Tags applied to a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the Content Fragment Model.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
tags	string[]	Yes	—	List of tag IDs to be added to the Content Fragment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tag IDs to be added to the Content Fragment"
    }
  },
  "required": [
    "PCID",
    "id",
    "If-Match",
    "tags"
  ]
}

---

adobe_experience_manager_sites_models_retrieve_uischema

Get the UI schema associated with the Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
X-Adobe-Accept-Unsupported-API	integer	Yes	—	The X-Adobe-Accept-Unsupported-API request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.
id	string	Yes	—	The ID of the Content Fragment Model.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "X-Adobe-Accept-Unsupported-API": {
      "type": "integer",
      "description": "The `X-Adobe-Accept-Unsupported-API` request header is required when a client wants to opt-in into using a product-only API, not designed for public consumption. Not providing this header to an endpoint that requires it will make the server answer with a 400 status code.",
      "enum": [
        1
      ]
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model."
    }
  },
  "required": [
    "PCID",
    "X-Adobe-Accept-Unsupported-API",
    "id"
  ]
}

---

adobe_experience_manager_sites_models_scheduled_publication_status_multiple_models

Get the scheduled publication status for a list of Content Fragment Models

Parameters:

Parameter	Type	Required	Default	Description
ids	string[]	Yes	—	The list of Content Fragment Model IDs.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of Content Fragment Model IDs."
    }
  },
  "required": [
    "PCID",
    "ids"
  ]
}

---

adobe_experience_manager_sites_models_search

Search API for Content Fragment Models based on various Search Criteria.

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
query	string	Yes	—	The query parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded.
projection	string	No	—	This parameter is optional. If set to ‘minimal’, the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to ‘summary’, the Content Fragment Model’s fields will not be populated in the response. If set to ‘full’, the response will include all properties. By default, the value of this query parameter is ‘full’.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "query": {
      "type": "string",
      "description": "The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded."
    },
    "projection": {
      "type": "string",
      "description": "This parameter is optional. If set to 'minimal', the response will include include only the resource identifiers of the Content Fragment Model: id, path, and name. If set to 'summary', the Content Fragment Model's fields will not be populated in the response. If set to 'full', the response will include all properties. By default, the value of this query parameter is 'full'.",
      "enum": [
        "minimal",
        "summary",
        "full"
      ]
    }
  },
  "required": [
    "PCID",
    "query"
  ]
}

---

adobe_experience_manager_sites_models_update_model

Edit a Content Fragment Model

Parameters:

Parameter	Type	Required	Default	Description
If-None-Match	string	No	—	The If-None-Match header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is ”*”, or having a selected representation with an entity tag that does not match any of those listed in the field value. For more details, please head over to RFC9110.
id	string	Yes	—	The ID of the Content Fragment Model to retrieve.
If-Match	string	Yes	—	The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is ”*”, or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value. For more details, please head over to RFC9110.
body	object[]	Yes	—	JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The application/json-patch+json media type is used to identify such patch documents. For more details check RFC 6902.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "If-None-Match": {
      "type": "string",
      "description": "The `If-None-Match` header field makes the request method conditional on a recipient cache or origin server either not having any current representation of the target resource, when the field value is \"*\", or having a selected representation with an entity tag that does not match any of those listed in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-none-match)."
    },
    "id": {
      "type": "string",
      "description": "The ID of the Content Fragment Model to retrieve."
    },
    "If-Match": {
      "type": "string",
      "description": "The `If-Match` header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is \"*\", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.  For more details, please head over to [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-if-match)."
    },
    "body": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "op": {
            "type": "string",
            "enum": [
              "add",
              "copy",
              "move",
              "remove",
              "replace",
              "test"
            ],
            "description": "The operation to perform"
          },
          "path": {
            "type": "string",
            "description": "A JSON Pointer (RFC 6901) referencing the target location"
          },
          "value": {
            "description": "The value to add/replace/test (required for add, replace, test operations)"
          },
          "from": {
            "type": "string",
            "description": "A JSON Pointer referencing the source location (required for copy and move operations)"
          }
        },
        "required": [
          "op",
          "path"
        ]
      },
      "description": "JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The `application/json-patch+json` media type is used to identify such patch documents.  For more details check [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902)."
    }
  },
  "required": [
    "PCID",
    "id",
    "If-Match",
    "body"
  ]
}

---

adobe_experience_manager_sites_permissions

Get the current’s user permissions on a list of resources

Parameters:

Parameter	Type	Required	Default	Description
paths	string[]	Yes	—	The list of resource paths - Content Fragments, Content Fragment Models and Folder - for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the /content/dam directory, the Content Fragment Models within the /conf directory, and the Folders could be within either /content/dam or the /conf directory.
preferredPermissions	string[]	No	—	The preferred list of permissions to return.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of resource paths - Content Fragments, Content Fragment Models and Folder -  for which the system has to return the list of permissions for a user. The Content Fragments are expected to be within the `/content/dam` directory, the Content Fragment Models within the `/conf` directory, and the Folders could be within either `/content/dam` or the `/conf` directory."
    },
    "preferredPermissions": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "READ",
          "EDIT",
          "RENAME",
          "DELETE",
          "PUBLISH",
          "CREATE_CONTENT_FRAGMENT",
          "CREATE_CONTENT_FRAGMENT_MODEL",
          "CHECKIN",
          "CHECKOUT"
        ]
      },
      "description": "The preferred list of permissions to return."
    }
  },
  "required": [
    "PCID",
    "paths"
  ]
}

---

adobe_experience_manager_sites_workflows_get_workflow

Get a Workflow

Parameters:

Parameter	Type	Required	Default	Description
workflowInstanceId	string	Yes	—	The workflow instance identifier.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "workflowInstanceId": {
      "type": "string",
      "description": "The workflow instance identifier."
    }
  },
  "required": [
    "PCID",
    "workflowInstanceId"
  ]
}

---

adobe_experience_manager_sites_workflows_get_workflows

List Workflows

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	When the number of results for a request exceeds the allowed limit, the response will include a cursor. That value can then be sent via this parameter on a subsequent request to retrieve the next set of items.
limit	integer	No	—	For a paginated request, this parameter defines the maximum number of items to retrieve.
query	string	No	—	The query parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "When the number of results for a request exceeds the allowed limit, the response will include a `cursor`.  That value can then be sent via this parameter on a subsequent request to retrieve the next set of items."
    },
    "limit": {
      "type": "integer",
      "description": "For a paginated request, this parameter defines the maximum number of items to retrieve."
    },
    "query": {
      "type": "string",
      "description": "The `query` parameter provides filtering and sorting criteria that should be applied when performing a search. The value passed should be valid JSON that has been URL encoded."
    }
  },
  "required": [
    "PCID"
  ]
}

---

adobe_experience_manager_sites_workflows_start

Start a workflow

Parameters:

Parameter	Type	Required	Default	Description
type	string	Yes	—	Type of workflow
workflowModelId	string	No	—	The workflow model id used for initiating the workflow instance
workflowTitle	string	No	—	A freely defined string used to identify the workflow when it executes.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "type": {
      "type": "string",
      "description": "Type of workflow",
      "enum": [
        "publish-folder",
        "unpublish-fragments",
        "unpublish-models",
        "create-translation-structure",
        "move-fragments",
        "rename-fragments"
      ]
    },
    "workflowModelId": {
      "type": "string",
      "description": "The workflow model id used for initiating the workflow instance"
    },
    "workflowTitle": {
      "type": "string",
      "description": "A freely defined string used to identify the workflow when it executes."
    }
  },
  "required": [
    "PCID",
    "type"
  ]
}