{"meta":{"title":"Migrations","intro":"移行カテゴリの GraphQL スキーマの種類に関するリファレンス ドキュメント。","product":"GraphQL API","breadcrumbs":[{"href":"/ja/graphql","title":"GraphQL API"},{"href":"/ja/graphql/reference","title":"リファレンス"},{"href":"/ja/graphql/reference/migrations","title":"Migrations"}],"documentType":"article"},"body":"# Migrations\n\n移行カテゴリの GraphQL スキーマの種類に関するリファレンス ドキュメント。\n\n## abortQueuedMigrations - mutation\n\nClear all of a customer's queued migrations.\n\n### Input fields for `abortQueuedMigrations`\n\n* `input` (AbortQueuedMigrationsInput!): \n\n### Return fields for `abortQueuedMigrations`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `success` (Boolean): Did the operation succeed?.\n\n## AbortQueuedMigrationsInput - input object\n\nAutogenerated input type of AbortQueuedMigrations.\n\n### Input fields for `AbortQueuedMigrationsInput`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `ownerId` (ID!): The ID of the organization that is running the migrations.\n\n## abortRepositoryMigration - mutation\n\nAbort a repository migration queued or in progress.\n\n### Input fields for `abortRepositoryMigration`\n\n* `input` (AbortRepositoryMigrationInput!): \n\n### Return fields for `abortRepositoryMigration`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `success` (Boolean): Did the operation succeed?.\n\n## AbortRepositoryMigrationInput - input object\n\nAutogenerated input type of AbortRepositoryMigration.\n\n### Input fields for `AbortRepositoryMigrationInput`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `migrationId` (ID!): The ID of the migration to be aborted.\n\n## createAttributionInvitation - mutation\n\nInvites a user to claim reattributable data.\n\n### Input fields for `createAttributionInvitation`\n\n* `input` (CreateAttributionInvitationInput!): \n\n### Return fields for `createAttributionInvitation`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `owner` (Organization): The owner scoping the reattributable data.\n* `source` (Claimable): The account owning the data to reattribute.\n* `target` (Claimable): The account which may claim the data.\n\n## CreateAttributionInvitationInput - input object\n\nAutogenerated input type of CreateAttributionInvitation.\n\n### Input fields for `CreateAttributionInvitationInput`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `ownerId` (ID!): The Node ID of the owner scoping the reattributable data.\n* `sourceId` (ID!): The Node ID of the account owning the data to reattribute.\n* `targetId` (ID!): The Node ID of the account which may claim the data.\n\n## createMigrationSource - mutation\n\nCreates a GitHub Enterprise Importer (GEI) migration source.\n\n### Input fields for `createMigrationSource`\n\n* `input` (CreateMigrationSourceInput!): \n\n### Return fields for `createMigrationSource`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `migrationSource` (MigrationSource): The created migration source.\n\n## CreateMigrationSourceInput - input object\n\nAutogenerated input type of CreateMigrationSource.\n\n### Input fields for `CreateMigrationSourceInput`\n\n* `accessToken` (String): The migration source access token.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `githubPat` (String): The GitHub personal access token of the user importing to the target repository.\n* `name` (String!): The migration source name.\n* `ownerId` (ID!): The ID of the organization that will own the migration source.\n* `type` (MigrationSourceType!): The migration source type.\n* `url` (String): The migration source URL, for example https://github.com or https://monalisa.ghe.com.\n\n## grantMigratorRole - mutation\n\nGrant the migrator role to a user or a team.\n\n### Input fields for `grantMigratorRole`\n\n* `input` (GrantMigratorRoleInput!): \n\n### Return fields for `grantMigratorRole`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `success` (Boolean): Did the operation succeed?.\n\n## GrantMigratorRoleInput - input object\n\nAutogenerated input type of GrantMigratorRole.\n\n### Input fields for `GrantMigratorRoleInput`\n\n* `actor` (String!): The user login or Team slug to grant the migrator role.\n* `actorType` (ActorType!): Specifies the type of the actor, can be either USER or TEAM.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `organizationId` (ID!): The ID of the organization that the user/team belongs to.\n\n## importProject - mutation\n\nCreates a new project by importing columns and a list of issues/PRs.\n\n> [!WARNING]\n> **Deprecation notice:** Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.\n\n### Input fields for `importProject`\n\n* `input` (ImportProjectInput!): \n\n### Return fields for `importProject`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `project` (Project): The new Project!.\n\n## ImportProjectInput - input object\n\nAutogenerated input type of ImportProject.\n\n### Input fields for `ImportProjectInput`\n\n* `body` (String): The description of Project.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `columnImports` ([ProjectColumnImport!]!): A list of columns containing issues and pull requests.\n* `name` (String!): The name of Project.\n* `ownerName` (String!): The name of the Organization or User to create the Project under.\n* `public` (Boolean): Whether the Project is public or not.\n\n## Mannequin - object\n\nA placeholder user for attribution of imported data on GitHub.\n\n**Implements:** Actor, Node, UniformResourceLocatable\n\n### Fields for `Mannequin`\n\n* `avatarUrl` (URI!): A URL pointing to the GitHub App's public avatar.\n  * `size` (Int): The size of the resulting square image.\n\n* `claimant` (User): The user that has claimed the data attributed to this mannequin.\n* `createdAt` (DateTime!): Identifies the date and time when the object was created.\n* `databaseId` (Int): Identifies the primary key from the database.\n* `email` (String): The mannequin's email on the source instance.\n* `id` (ID!): The Node ID of the Mannequin object.\n* `login` (String!): The username of the actor.\n* `name` (String): The display name of the imported mannequin.\n* `resourcePath` (URI!): The HTML path to this resource.\n* `updatedAt` (DateTime!): Identifies the date and time when the object was last updated.\n* `url` (URI!): The URL to this resource.\n\n## MannequinConnection - object\n\nA list of mannequins.\n\n### Fields for `MannequinConnection`\n\n* `edges` ([MannequinEdge]): A list of edges.\n* `nodes` ([Mannequin]): A list of nodes.\n* `pageInfo` (PageInfo!): Information to aid in pagination.\n* `totalCount` (Int!): Identifies the total count of items in the connection.\n\n## MannequinEdge - object\n\nRepresents a mannequin.\n\n### Fields for `MannequinEdge`\n\n* `cursor` (String!): A cursor for use in pagination.\n* `node` (Mannequin): The item at the end of the edge.\n\n## MannequinOrder - input object\n\nOrdering options for mannequins.\n\n### Input fields for `MannequinOrder`\n\n* `direction` (OrderDirection!): The ordering direction.\n* `field` (MannequinOrderField!): The field to order mannequins by.\n\n## MannequinOrderField - enum\n\nProperties by which mannequins can be ordered.\n\n### Values for `MannequinOrderField`\n\n* `CREATED_AT`: Order mannequins why when they were created.\n* `LOGIN`: Order mannequins alphabetically by their source login.\n\n## Migration - interface\n\nRepresents a GitHub Enterprise Importer (GEI) migration.\n\n### Fields for `Migration`\n\n* `continueOnError` (Boolean!): The migration flag to continue on error.\n* `createdAt` (DateTime!): Identifies the date and time when the object was created.\n* `databaseId` (String): Identifies the primary key from the database.\n* `failureReason` (String): The reason the migration failed.\n* `id` (ID!): The Node ID of the Migration object.\n* `migrationLogUrl` (URI): The URL for the migration log (expires 1 day after migration completes).\n* `migrationSource` (MigrationSource!): The migration source.\n* `repositoryName` (String!): The target repository name.\n* `sourceUrl` (URI!): The migration source URL, for example https://github.com or https://monalisa.ghe.com.\n* `state` (MigrationState!): The migration state.\n* `warningsCount` (Int!): The number of warnings encountered for this migration. To review the warnings,\ncheck the Migration Log.\n\n### Implemented by\n\n* RepositoryMigration\n\n## MigrationSource - object\n\nA GitHub Enterprise Importer (GEI) migration source.\n\n**Implements:** Node\n\n### Fields for `MigrationSource`\n\n* `id` (ID!): The Node ID of the MigrationSource object.\n* `name` (String!): The migration source name.\n* `type` (MigrationSourceType!): The migration source type.\n* `url` (URI!): The migration source URL, for example https://github.com or https://monalisa.ghe.com.\n\n## MigrationSourceType - enum\n\nRepresents the different GitHub Enterprise Importer (GEI) migration sources.\n\n### Values for `MigrationSourceType`\n\n* `AZURE_DEVOPS`: An Azure DevOps migration source.\n* `BITBUCKET_SERVER`: A Bitbucket Server migration source.\n* `GITHUB_ARCHIVE`: A GitHub Migration API source.\n\n## MigrationState - enum\n\nThe GitHub Enterprise Importer (GEI) migration state.\n\n### Values for `MigrationState`\n\n* `FAILED`: The migration has failed.\n* `FAILED_VALIDATION`: The migration has invalid credentials.\n* `IN_PROGRESS`: The migration is in progress.\n* `NOT_STARTED`: The migration has not started.\n* `PENDING_VALIDATION`: The migration needs to have its credentials validated.\n* `QUEUED`: The migration has been queued.\n* `SUCCEEDED`: The migration has succeeded.\n\n## OrganizationMigration - object\n\nA GitHub Enterprise Importer (GEI) organization migration.\n\n**Implements:** Node\n\n### Fields for `OrganizationMigration`\n\n* `createdAt` (DateTime!): Identifies the date and time when the object was created.\n* `databaseId` (String): Identifies the primary key from the database.\n* `failureReason` (String): The reason the organization migration failed.\n* `id` (ID!): The Node ID of the OrganizationMigration object.\n* `remainingRepositoriesCount` (Int): The remaining amount of repos to be migrated.\n* `sourceOrgName` (String!): The name of the source organization to be migrated.\n* `sourceOrgUrl` (URI!): The URL of the source organization to migrate.\n* `state` (OrganizationMigrationState!): The migration state.\n* `targetOrgName` (String!): The name of the target organization.\n* `totalRepositoriesCount` (Int): The total amount of repositories to be migrated.\n\n## OrganizationMigrationState - enum\n\nThe Octoshift Organization migration state.\n\n### Values for `OrganizationMigrationState`\n\n* `FAILED`: The Octoshift migration has failed.\n* `FAILED_VALIDATION`: The Octoshift migration has invalid credentials.\n* `IN_PROGRESS`: The Octoshift migration is in progress.\n* `NOT_STARTED`: The Octoshift migration has not started.\n* `PENDING_VALIDATION`: The Octoshift migration needs to have its credentials validated.\n* `POST_REPO_MIGRATION`: The Octoshift migration is performing post repository migrations.\n* `PRE_REPO_MIGRATION`: The Octoshift migration is performing pre repository migrations.\n* `QUEUED`: The Octoshift migration has been queued.\n* `REPO_MIGRATION`: The Octoshift org migration is performing repository migrations.\n* `SUCCEEDED`: The Octoshift migration has succeeded.\n\n## RepositoryMigration - object\n\nA GitHub Enterprise Importer (GEI) repository migration.\n\n**Implements:** Migration, Node\n\n### Fields for `RepositoryMigration`\n\n* `continueOnError` (Boolean!): The migration flag to continue on error.\n* `createdAt` (DateTime!): Identifies the date and time when the object was created.\n* `databaseId` (String): Identifies the primary key from the database.\n* `failureReason` (String): The reason the migration failed.\n* `id` (ID!): The Node ID of the RepositoryMigration object.\n* `migrationLogUrl` (URI): The URL for the migration log (expires 1 day after migration completes).\n* `migrationSource` (MigrationSource!): The migration source.\n* `repositoryName` (String!): The target repository name.\n* `sourceUrl` (URI!): The migration source URL, for example https://github.com or https://monalisa.ghe.com.\n* `state` (MigrationState!): The migration state.\n* `warningsCount` (Int!): The number of warnings encountered for this migration. To review the warnings,\ncheck the Migration Log.\n\n## RepositoryMigrationConnection - object\n\nA list of migrations.\n\n### Fields for `RepositoryMigrationConnection`\n\n* `edges` ([RepositoryMigrationEdge]): A list of edges.\n* `nodes` ([RepositoryMigration]): A list of nodes.\n* `pageInfo` (PageInfo!): Information to aid in pagination.\n* `totalCount` (Int!): Identifies the total count of items in the connection.\n\n## RepositoryMigrationEdge - object\n\nRepresents a repository migration.\n\n### Fields for `RepositoryMigrationEdge`\n\n* `cursor` (String!): A cursor for use in pagination.\n* `node` (RepositoryMigration): The item at the end of the edge.\n\n## RepositoryMigrationOrder - input object\n\nOrdering options for repository migrations.\n\n### Input fields for `RepositoryMigrationOrder`\n\n* `direction` (RepositoryMigrationOrderDirection!): The ordering direction.\n* `field` (RepositoryMigrationOrderField!): The field to order repository migrations by.\n\n## RepositoryMigrationOrderDirection - enum\n\nPossible directions in which to order a list of repository migrations when provided an orderBy argument.\n\n### Values for `RepositoryMigrationOrderDirection`\n\n* `ASC`: Specifies an ascending order for a given orderBy argument.\n* `DESC`: Specifies a descending order for a given orderBy argument.\n\n## RepositoryMigrationOrderField - enum\n\nProperties by which repository migrations can be ordered.\n\n### Values for `RepositoryMigrationOrderField`\n\n* `CREATED_AT`: Order mannequins why when they were created.\n\n## revokeMigratorRole - mutation\n\nRevoke the migrator role from a user or a team.\n\n### Input fields for `revokeMigratorRole`\n\n* `input` (RevokeMigratorRoleInput!): \n\n### Return fields for `revokeMigratorRole`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `success` (Boolean): Did the operation succeed?.\n\n## RevokeMigratorRoleInput - input object\n\nAutogenerated input type of RevokeMigratorRole.\n\n### Input fields for `RevokeMigratorRoleInput`\n\n* `actor` (String!): The user login or Team slug to revoke the migrator role from.\n* `actorType` (ActorType!): Specifies the type of the actor, can be either USER or TEAM.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `organizationId` (ID!): The ID of the organization that the user/team belongs to.\n\n## startOrganizationMigration - mutation\n\nStarts a GitHub Enterprise Importer organization migration.\n\n### Input fields for `startOrganizationMigration`\n\n* `input` (StartOrganizationMigrationInput!): \n\n### Return fields for `startOrganizationMigration`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `orgMigration` (OrganizationMigration): The new organization migration.\n\n## StartOrganizationMigrationInput - input object\n\nAutogenerated input type of StartOrganizationMigration.\n\n### Input fields for `StartOrganizationMigrationInput`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `sourceAccessToken` (String!): The migration source access token.\n* `sourceOrgUrl` (URI!): The URL of the organization to migrate.\n* `targetEnterpriseId` (ID!): The ID of the enterprise the target organization belongs to.\n* `targetOrgName` (String!): The name of the target organization.\n\n## startRepositoryMigration - mutation\n\nStarts a GitHub Enterprise Importer (GEI) repository migration.\n\n### Input fields for `startRepositoryMigration`\n\n* `input` (StartRepositoryMigrationInput!): \n\n### Return fields for `startRepositoryMigration`\n\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `repositoryMigration` (RepositoryMigration): The new repository migration.\n\n## StartRepositoryMigrationInput - input object\n\nAutogenerated input type of StartRepositoryMigration.\n\n### Input fields for `StartRepositoryMigrationInput`\n\n* `accessToken` (String): The migration source access token.\n* `clientMutationId` (String): A unique identifier for the client performing the mutation.\n* `continueOnError` (Boolean): Whether to continue the migration on error. Defaults to true.\n* `gitArchiveUrl` (String): The signed URL to access the user-uploaded git archive.\n* `githubPat` (String): The GitHub personal access token of the user importing to the target repository.\n* `lockSource` (Boolean): Whether to lock the source repository.\n* `metadataArchiveUrl` (String): The signed URL to access the user-uploaded metadata archive.\n* `ownerId` (ID!): The ID of the organization that will own the imported repository.\n* `repositoryName` (String!): The name of the imported repository.\n* `skipReleases` (Boolean): Whether to skip migrating releases for the repository.\n* `sourceId` (ID!): The ID of the migration source.\n* `sourceRepositoryUrl` (URI!): The URL of the source repository.\n* `targetRepoVisibility` (String): The visibility of the imported repository."}