@salesforce/lds-adapters-industries-filebased-dataimport 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,760 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  FieldConfigurationInputRepresentation:
+    description: Input representation of the field configurations from CSV columns
+      to Salesforce Object Columns for the Data Import Job
+    type: object
+    properties:
+      isLookupRelationship:
+        description: To identify wether it is a lookup relationship
+        type: boolean
+        required: false
+      relatedFieldName:
+        description: The name of the field of the object of the lookup relationship.
+        type: string
+        required: false
+      relatedObjectName:
+        description: The name of the object where the lookup needs to be performed
+          for this entity field
+        type: string
+        required: false
+      sourceColumnName:
+        description: The name of the column of the source content for this mapping
+          definition
+        type: string
+        required: false
+      targetFieldName:
+        description: The field name of the targeted import object for this mapping
+          definition
+        type: string
+        required: false
+      relationshipName:
+        description: The relationship name of the lookup
+          definition
+        type: string
+        required: false
+  FileImportInputRepresentation:
+    description: Input representation of payload for File Based Data Import Use Case
+    type: object
+    properties:
+      importReferenceId:
+        description: The id of the file based data import functionality entity
+        type: string
+      options:
+        description: The Options and configurations of the import job
+        type: ImportOptionsInputRepresentation
+        required: false
+      targetContext:
+        description: The target context of import be it a object or a import template
+        type: string
+  FileImportOutputRepresentation:
+    description: Output representation of a File Based Import Job
+    type: object
+    properties:
+      statusCode:
+        description: The status code of the Start Import Job API
+        type: string
+      statusMessage:
+        description: The status message of the Start Import Job API
+        type: string
+  ImportOperationInputRepresentation:
+    description: Input representation of operations for File Based Import Case
+    type: object
+    properties:
+      operationType:
+        description: The operation type of the import job
+        type: string
+        required: false
+      uniqueFields:
+        description: The unique fields of the object on which Update or upsert kind
+          of operations are to be performed
+        type: array
+        required: false
+        items:
+          type: string
+  ImportOptionsInputRepresentation:
+    description: Input representation of Options for File Based Import
+    type: object
+    properties:
+      delimiter:
+        description: The delimiter of the source content document
+        type: string
+        required: false
+      eol:
+        description: The End of Line character for the file used for import
+        type: string
+        required: false
+      fieldConfigurations:
+        description: The list of field configurations
+        type: array
+        required: false
+        items:
+          type: FieldConfigurationInputRepresentation
+      operation:
+        description: The operation type of the import job
+        type: ImportOperationInputRepresentation
+        required: false
+  FileBasedDataImportByUserResultRepresentation:
+    description: Output representation file based data imports as per user context
+    type: object
+    properties:
+      isAdminUser?:
+        description: True if user has admin role
+        type: boolean
+      fileBasedDataImportRepresentations?:
+        description: The file based data import response
+        type: array
+        items:
+          type: FileBasedDataImportRepresentation
+  CsvPreviewOutputRepresentation:
+    description: Output representation of CSV Data Preview
+    type: object
+    properties:
+      headers:
+        description: List of header
+        type: array
+        items:
+          type: string
+      rows?:
+        description: List of rows data fetched
+        type: array
+        items:
+          type: array
+          items:
+            type: string | nil
+  CSVMappingsResultRepresentation:
+    description: Output representation of auto map of csv headers with entity
+    type: object
+    properties:
+      csvMappingRepresentations:
+        description: Auto Map Result list
+        type: array
+        items:
+          type: CsvMappingRepresentation
+  CsvMappingRepresentation:
+    description: Output representation of auto map of csv headers with entity
+    type: object
+    properties:
+      csvHeader:
+        description: CSV Header
+        type: string
+      hasUserAccess?:
+        description: 'Has User Access to the entity column, based on the access level
+          in the '
+        type: boolean | nil
+      mappedEntityColumn?:
+        description: Mapped Entity Column Info Representation
+        type: FieldInfoRepresentation | nil
+      sampleValue?:
+        description: Sample Value for the CSV Header
+        type: string | nil
+
+  FieldInfoOutputRepresentation:
+    description: List of Field info output representation
+    type: object
+    properties:
+      fields?:
+        description: get list of fields
+        type: array
+        items:
+          type: FieldInfoRepresentation
+
+  FieldInfoRepresentation:
+    description: Field info representation
+    type: object
+    properties:
+      createable?:
+        description: createable
+        type: boolean
+      custom?:
+        description: isCustom
+        type: boolean
+      dataType?:
+        description: dataType of field
+        type: string
+        enum:
+          - ADDRESS
+          - ANYTYPE
+          - BASE64
+          - BOOLEAN
+          - COMBOBOX
+          - COMPLEXVALUE
+          - CURRENCY
+          - DATE
+          - DATETIME
+          - DOUBLE
+          - EMAIL
+          - ENCRYPTEDSTRING
+          - ID
+          - INT
+          - JSON
+          - JUNCTIONIDLIST
+          - LOCATION
+          - LONG
+          - MULTIPICKLIST
+          - PERCENT
+          - PHONE
+          - PICKLIST
+          - REFERENCE
+          - STRING
+          - TEXTAREA
+          - TIME
+          - URL
+      externalId?:
+        description: isExternalId
+        type: boolean
+      filterable?:
+        description: filterable
+        type: boolean
+      label?:
+        description: label
+        type: string
+      mandatory?:
+        description: isMandatory
+        type: boolean
+      name?:
+        description: name
+        type: string
+      referenceTo?:
+        description: referenceTo
+        type: array
+        items:
+          type: ReferenceEntityInfo
+      relationshipName?:
+        description: relationshipName
+        type: string
+      required?:
+        description: required
+        type: boolean
+      sortable?:
+        description: sortable
+        type: boolean
+      updateable?:
+        description: updateable
+        type: boolean
+      idLookup?:
+        description: idLookup
+        type: boolean
+      unique?:
+        description: unique
+        type: boolean
+
+  ReferenceEntityInfo:
+    description: Referenced Entity info
+    type: object
+    properties:
+      entityName:
+        type: string
+        description: entityName
+      entityLabel:
+        type: string
+        description: entityLabel
+      fields:
+        type: array
+        description: Entity id look up fields
+        items:
+          type: ReferenceFieldInfo
+
+  ReferenceFieldInfo:
+    description: Referenced Field info
+    type: object
+    properties:
+      fieldName:
+        type: string
+        description: fieldName
+      fieldLabel:
+        type: string
+        description: fieldLabel
+
+  FileBasedDataImportRepresentation:
+    description: File based Data import Entity output representation
+    type: object
+    properties:
+      id:
+        description: ID
+        type: string
+      createdBy?:
+        description: createdBy
+        type: string
+      failedRecordsCount?:
+        description: FailedRecordsCount
+        type: integer
+      failedResults?:
+        description: FailedResults
+        type: string | nil
+      fileBasedImportType:
+        description: FileBasedImportType
+        type: string
+        enum:
+          - ADVANCED
+          - SIMPLE
+      importOperationType:
+        description: ImportOperationType
+        type: string
+        enum:
+          - INSERT
+          - UPDATE
+          - UPSERT
+      jobIdentifier?:
+        description: JobIdentifier
+        type: string | nil
+      lastModifiedDate?:
+        description: lastModifiedDate
+        type: string
+      sourceContentDocument?:
+        description: SourceContentDocument
+        type: string | nil
+      sourceFileName:
+        description: SourceFileName
+        type: string
+      status:
+        description: Status
+        type: string
+        enum:
+          - ABORTED
+          - COMPLETED
+          - FAILED
+          - INPROGRESS
+          - PENDING
+      statusReason?:
+        description: StatusReason
+        type: string | nil
+      successRecordsCount?:
+        description: SuccessRecordsCount
+        type: integer
+      successfulResults?:
+        description: SuccessfulResults
+        type: string | nil
+      targetContext?:
+        description: TargetContext
+        type: string | nil
+      unprocessedRecords?:
+        description: UnprocessedRecords
+        type: string | nil
+      unprocessedRecordsCount?:
+        description: UnprocessedRecordsCount
+        type: integer
+      parentJobId?:
+        description: ParentJobId
+        type: string | nil
+      createdDate?:
+        description: createdDate
+        type: string
+  FileBasedDataImportInputRep:
+    description: 'Input representation for File Based Data Import '
+    type: object
+    properties:
+      failedRecordContentDoc?:
+        description: The failed record content doc of the file based data import functionality
+          entity
+        type: string
+      failedRecordCount?:
+        description: The failed record count of the file based data import functionality
+          entity
+        type: integer
+      id?:
+        description: The sourceFileName of the file based data import functionality
+          entity
+        type: string
+      importOperationType?:
+        description: The importOperationType of the file based data import functionality
+          entity
+        type: string
+        enum:
+          - INSERT
+          - UPDATE
+          - UPSERT
+      importType?:
+        description: The importType of the file based data import functionality entity
+        type: string
+        enum:
+          - ADVANCED
+          - SIMPLE
+      jobIdentifier?:
+        description: The job identifier of the file based data import functionality
+          entity
+        type: string
+      sourceContentDocument?:
+        description: The sourceContentDocument of the file based data import functionality
+          entity
+        type: string
+      sourceFileName:
+        description: The sourceFileName of the file based data import functionality
+          entity
+        type: string
+      status?:
+        description: The status of the file based data import functionality entity
+        type: string
+        enum:
+          - ABORTED
+          - COMPLETED
+          - FAILED
+          - INPROGRESS
+          - PENDING
+      statusReason?:
+        description: The status reason of the file based data import functionality
+          entity
+        type: string
+      successfulRecordContentDoc?:
+        description: The successful record content doc of the file based data import
+          functionality entity
+        type: string
+      successfulRecordCount?:
+        description: The successful record count  of the file based data import functionality
+          entity
+        type: integer
+      targetContext?:
+        description: The targetContext of the file based data import functionality
+          entity
+        type: string
+      unprocessedRecordContentDoc?:
+        description: The unprocessed record content doc of the file based data import
+          functionality entity
+        type: string
+      unprocessedRecordCount?:
+        description: The unprocessed record count of the file based data import functionality
+          entity
+        type: integer
+  FileBasedDataImportUpdateInputRep:
+    description: 'Input representation for File Based Data Import '
+    type: object
+    properties:
+      failedRecordContentDoc?:
+        description: The failed record content doc of the file based data import functionality
+          entity
+        type: string
+      failedRecordCount?:
+        description: The failed record count of the file based data import functionality
+          entity
+        type: integer
+      importOperationType?:
+        description: The importOperationType of the file based data import functionality
+          entity
+        type: string
+        enum:
+          - INSERT
+          - UPDATE
+          - UPSERT
+      importType?:
+        description: The importType of the file based data import functionality entity
+        type: string
+        enum:
+          - ADVANCED
+          - SIMPLE
+      jobIdentifier?:
+        description: The job identifier of the file based data import functionality
+          entity
+        type: string
+      sourceContentDocument?:
+        description: The sourceContentDocument of the file based data import functionality
+          entity
+        type: string
+      sourceFileName?:
+        description: The sourceFileName of the file based data import functionality
+          entity
+        type: string
+      status?:
+        description: The status of the file based data import functionality entity
+        type: string
+        enum:
+          - ABORTED
+          - COMPLETED
+          - FAILED
+          - INPROGRESS
+          - PENDING
+      statusReason?:
+        description: The status reason of the file based data import functionality
+          entity
+        type: string
+      successfulRecordContentDoc?:
+        description: The successful record content doc of the file based data import
+          functionality entity
+        type: string
+      successfulRecordCount?:
+        description: The successful record count  of the file based data import functionality
+          entity
+        type: integer
+      targetContext?:
+        description: The targetContext of the file based data import functionality
+          entity
+        type: string
+      unprocessedRecordContentDoc?:
+        description: The unprocessed record content doc of the file based data import
+          functionality entity
+        type: string
+      unprocessedRecordCount?:
+        description: The unprocessed record count of the file based data import functionality
+          entity
+        type: integer
+  DPEDefinitionOutputRepresentation:
+    description: Output representation of DPE Definition
+    type: object
+    properties:
+      dpeDefinitions:
+        description: List of dpe definitions
+        type: array
+        items:
+          type: DPEDefinitionRepresentation
+  DPEDefinitionRepresentation:
+    description: Output representation of DPE Definition
+    type: object
+    properties:
+      id:
+        description: Id of the target context
+        type: string
+      name:
+        description: Name of the target context
+        type: string
+      type:
+        description: Type of the target context
+        type: string
+        enum:
+          - DEFINITION
+          - TEMPLATE
+  ObjectInfoDirectoryEntryRepresentation:
+    description: Entry for an object info within the directory of objects.
+    type: object
+    properties:
+      apiName:
+        description: The API name of the object info corresponding to this entry.
+        type: string
+      keyPrefix:
+        description: The key prefix for IDs of this object.
+        type: string | nil
+      label:
+        description: The label of the object info corresponding to this entry.
+        type: string
+      labelPlural:
+        description: The plural label of the object info corresponding to this entry.
+        type: string
+      nameFields:
+        description: List of the API names of the fields used to identify the name
+          field for standard and custom objects. Typically there is one name field
+          per object, except where FirstName and LastName fields are used.
+        type: array
+        items:
+          type: string
+      objectInfoUrl:
+        description: The URL to retrieve the full object info corresponding to this
+          entry.
+        type: string
+  ObjectInfoDirectoryRepresentation:
+    description: Directory of objects that can be used within UI API end-points.
+    type: object
+    properties:
+      objects:
+        description: The object info entries corresponding to the objects that can
+          be used within UI API.
+        type: object
+        properties:
+          //:
+            # These definitions are copied from lds-adapters-uiapi & need to remain in sync with those to avoid data inconsistences while caching.
+            type: ObjectInfoDirectoryEntryRepresentation
+/connect/industries/fileBasedDataImports:
+  get:
+    displayName: GetFileBasedDataImportByUser
+    description: Api to fetch details related to mulesoft asset from metadata
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FileBasedDataImportByUserResultRepresentation
+  post:
+    displayName: createFileBasedDataImport
+    description: API resource to create file based data import
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FileBasedDataImportRepresentation
+    body:
+      application/json:
+        type: FileBasedDataImportInputRep
+
+  /advanceImport:
+    post:
+      displayName: postAdvanceImport
+      description: API resource to start Advance data import
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FileImportOutputRepresentation
+      body:
+        application/json:
+          type: FileImportInputRepresentation
+  /simpleImport:
+    post:
+      displayName: postSimpleImport
+      description: API resource to start Simple data import
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FileImportOutputRepresentation
+      body:
+        application/json:
+          type: FileImportInputRepresentation
+  /{fileBasedImportId}:
+    delete:
+      displayName: deleteFileBasedDataImport
+      description: API resource to create file based data import
+      responses:
+        '200':
+          description: Success
+    get:
+      displayName: getFileBasedDataImportById
+      description: Get a list of trackers set up for this orchestration.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FileBasedDataImportRepresentation
+    patch:
+      displayName: updateFileBasedDataImport
+      description: API resource to create file based data import
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FileBasedDataImportRepresentation
+      body:
+        application/json:
+          type: FileBasedDataImportUpdateInputRep
+    uriParameters:
+      fileBasedImportId:
+        type: string
+        required: true
+
+    /preview:
+      get:
+        displayName: getCsvPreviewData
+        description: Api to fetch preview of the csv file upto max 10 rows
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CsvPreviewOutputRepresentation
+        queryParameters:
+          delimiter:
+            type: string
+            required: false
+          endOfLine:
+            type: string
+            required: false
+          numberOfRows:
+            type: integer
+            required: false
+      uriParameters:
+        fileBasedImportId:
+          type: string
+          required: true
+  /dpeDefinitions:
+    get:
+      displayName: getDPEDefinitions
+      description: Api to fetch DPE definitions
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: DPEDefinitionOutputRepresentation
+  /entities:
+    get:
+      displayName: getAllSobjects
+      description: Api to fetch all sobjects
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ObjectInfoDirectoryRepresentation
+      queryParameters:
+        batchSize:
+          type: integer
+          required: false
+        searchText:
+          type: string
+          required: false
+        startOffset:
+          type: integer
+          required: false
+  /entities/{entityApiName}/fields:
+    get:
+      displayName: getAllFields
+      description: Api to fetch fields of a given entity
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: FieldInfoOutputRepresentation
+      queryParameters:
+        batchSize:
+          type: integer
+          required: false
+        fieldName:
+          type: string
+          required: false
+        startOffset:
+          type: integer
+          required: false
+    uriParameters:
+      entityApiName:
+        type: string
+        required: true
+  /automap:
+    get:
+      displayName: getCsvAutoMap
+      description: Api to auto map Csv data to entity records based on mapping configuration
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: CSVMappingsResultRepresentation
+      queryParameters:
+        contentDocumentId:
+          type: string
+          required: true
+        delimiter:
+          type: string
+          required: false
+        endOfLine:
+          type: string
+          required: false
+        entityApiName:
+          type: string
+          required: true