fabric-rest-api-specs/copyJob/definitions.json

{
  "swagger": "2.0",
  "info": {
    "title": "CopyJob data types",
    "version": "v1"
  },
  "paths": {},
  "definitions": {
    "CopyJob": {
      "description": "A CopyJob object.",
      "type": "object",
      "required": [ "type" ],
      "allOf": [
        {
          "$ref": "../common/definitions.json#/definitions/Item"
        }
      ]
    },
    "CopyJobs": {
      "description": "A list of CopyJobs.",
      "required": [ "value" ],
      "type": "object",
      "properties": {
        "value": {
          "description": "A list of CopyJobs.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/CopyJob"
          }
        }
      },
      "allOf": [
        {
          "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
        }
      ]
    },
    "CreateCopyJobRequest": {
      "description": "Create CopyJob request payload.",
      "required": [ "displayName" ],
      "properties": {
        "displayName": {
          "description": "The CopyJob display name. The display name must follow naming rules according to item type.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The CopyJob description. Maximum length is 256 characters.",
          "type": "string",
          "readOnly": false
        },
        "folderId": {
            "description": "The folder ID. If not specified or null, the CopyJob is created with the workspace as its folder.",
            "type": "string",
            "format": "uuid",
            "readOnly": false
        },
        "definition": {
          "description": "The CopyJob public definition.",
          "$ref": "#/definitions/CopyJobDefinition",
          "readOnly": false
        },
        "sensitivityLabelSettings": {
          "description": "The sensitivity label settings for the CopyJob.",
          "$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
          "readOnly": false
        }
      }
    },
    "UpdateCopyJobDefinitionRequest": {
      "description": "Update CopyJob public definition request payload.",
      "required": [ "definition" ],
      "properties": {
        "definition": {
          "$ref": "#/definitions/CopyJobDefinition"
        }
      }
    },
    "CopyJobDefinitionResponse": {
      "description": "CopyJob public definition response.",
      "required": [ "definition" ],
      "properties": {
        "definition": {
          "$ref": "#/definitions/CopyJobDefinition",
          "readOnly": true
        }
      }
    },
    "CopyJobDefinition": {
      "description": "CopyJob public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/copyjob-definition) for more details on the structure of the CopyJob definition.",
      "type": "object",
      "required": [ "parts" ],
      "properties": {
        "format": {
          "description": "The format of the copy job definition.",
          "type": "string",
          "readOnly": false
        },
        "parts": {
          "description": "A list of definition parts.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/CopyJobDefinitionPart"
          },
          "readOnly": false
        }
      }
    },
    "CopyJobDefinitionPart": {
      "description": "CopyJob definition part object.",
      "type": "object",
      "properties": {
        "path": {
          "description": "The CopyJob public definition part path.",
          "type": "string",
          "readOnly": false
        },
        "payload": {
          "description": "The CopyJob public definition part payload.",
          "type": "string",
          "readOnly": false
        },
        "payloadType": {
          "description": "The payload type.",
          "$ref": "../common/definitions.json#/definitions/PayloadType",
          "readOnly": false
        }
      }
    },
    "UpdateCopyJobRequest": {
      "description": "Update CopyJob request.",
      "properties": {
        "displayName": {
          "description": "The CopyJob display name. The display name must follow naming rules according to item type.",
          "type": "string",
          "readOnly": false
        },
        "description": {
          "description": "The CopyJob description. Maximum length is 256 characters.",
          "type": "string",
          "readOnly": false
        }
      }
    },
    "CopyJobEntityResetPayload": {
      "description": "A list of CopyJobEntities to reset.",
      "type": "object",
      "properties": {
        "resetAllCopyJobEntities": {
          "description": "Whether to reset all CopyJob entities.",
          "type": "boolean"
        },
        "copyJobEntitiesToReset": {
          "description": "A list of CopyJob entities to reset.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/CopyJobEntityReset"
          }
        }
      }
    },
    "CopyJobEntityReset": {
      "description": "The Id of a CopyJobEntity to reset.",
      "type": "object",
      "properties": {
        "copyJobEntityId": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "CopyJobExecuteJobInstance": {
      "description": "A CopyJob execute job instance.",
      "type": "object",
      "allOf": [
        {
          "$ref": "../platform/definitions/platform.json#/definitions/ItemJobInstance"
        }
      ]
    },
    "CopyJobExecuteJobInstances": {
      "description": "A list of CopyJob execute job instances.",
      "required": [
        "value"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
        }
      ],
      "properties": {
        "value": {
          "description": "A list of CopyJob execute job instances.",
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/CopyJobExecuteJobInstance"
          }
        }
      }
    }
  }
}