Merge Conflict

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Merge Conflict is contained within a Repository.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system

Methods

The following methods are available:

Check Permission

Checks whether one or more authorities against the specified merge-conflict are granted for a given set of users
POST /repositories/{repositoryId}/conflicts/{conflictId}/permissions/{permissionId}/check

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
permissionId true string The ID of the permission
id true string

Response

{
  "$ref": "#/components/schemas/checkPermission"
}

Check Single Authority

Checks whether a single authority is granted against the specified merge-conflict for the given user
POST /repositories/{repositoryId}/conflicts/{conflictId}/authorities/{authorityId}/check

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified merge-conflict are granted for a given set of users
POST /repositories/{repositoryId}/conflicts/authorities/check

Parameters

Name Required Type Description
repositoryId true string The ID of the repository

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether one or more permissions against the specified merge-conflict are granted for a given set of users
POST /repositories/{repositoryId}/conflicts/permissions/check

Parameters

Name Required Type Description
repositoryId true string The ID of the repository

Response

{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Commit

POST /repositories/{repositoryId}/conflicts/{conflictId}/commit

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
branch false string

Response

{}

Conflicts

GET /repositories/{repositoryId}/conflicts

Parameters

Name Required Type Description
repositoryId true string The ID of the repository

Response

{}

Delete

POST /repositories/{repositoryId}/conflicts/{conflictId}/delete

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{}

Evaluate

POST /repositories/{repositoryId}/conflicts/{conflictId}/evaluate

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{}

Grant Authority

Grants an authority against the specified merge-conflict to a given user
POST /repositories/{repositoryId}/conflicts/{conflictId}/authorities/{authorityId}/grant

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Query

Queries for matches
POST /repositories/{repositoryId}/conflicts/query

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set
This method supports pagination.

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified merge-conflict
GET /repositories/{repositoryId}/conflicts/{conflictId}/acl/list

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Reads the ACL for a merge conflict and specific actor
GET /repositories/{repositoryId}/conflicts/{conflictId}/acl

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
id true string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Authorities Report

Read the Authorities Report for the specified merge-conflict
POST /repositories/{repositoryId}/conflicts/{conflictId}/authorities

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Resolve

POST /repositories/{repositoryId}/conflicts/{conflictId}/resolve

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
resolution false string

Response

{}

Revoke Authority

Revokes an authority against the specified merge-conflict from a given user
POST /repositories/{repositoryId}/conflicts/{conflictId}/authorities/{authorityId}/revoke

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
authorityId true string The ID or authority key for the authority
id true string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Starts an export job for this resource

Starts an export job for this resource
POST /repositories/{repositoryId}/conflicts/{conflictId}/export

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

Starts an import job for this resource
POST /repositories/{repositoryId}/conflicts/{conflictId}/import

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string
groupId false string The Group ID to be assigned to the exported archive
artifactId false string The Artifact ID to be assigned to the exported archive
versionId false string The Version ID to be assigned to the exported archive
vaultId false string The ID of the vault where the exported archive should be saved
schedule false string Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Update

POST /repositories/{repositoryId}/conflicts/{conflictId}/update

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{}

{conflictId}

GET /repositories/{repositoryId}/conflicts/{conflictId}

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{}

{conflictId}

PUT /repositories/{repositoryId}/conflicts/{conflictId}

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{}

{conflictId}

DELETE /repositories/{repositoryId}/conflicts/{conflictId}

Parameters

Name Required Type Description
repositoryId true string The ID of the repository
conflictId true string

Response

{}

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Merge Conflict",
  "container": "repository",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "merge-conflict"
}