Jump to

• Request
• Response

Replace file links

put

/api/field-service/core/v1/inventories/{inventoryId}/externalFilesInfo/{propertyLabel}

This operation uploads information about external links to file attachments to the specified inventory property. The property should have the type 'Attachments' configured with the 'OCI Object Storage' storage type.

Request

Supported Media Types

• application/json

Path Parameters

• inventoryId(required): integer
  The unique identifier of the inventory in Oracle Field Service.
• propertyLabel(required): string
  The label of a custom property. This custom property must be of type 'file'.

Body ()

Root Schema : Replace File Links Request

Type: object

Title: Replace File Links Request

The payload containing external file links to store in the specified inventory property.

Show Source

• items: array Items
  Title: Items

  The collection of external file information objects.
• operationType: string
  Title: Operation Type

  Default Value: replace

  Allowed Values: [ "replace", "update" ]

  The type of the operation. Allowed values are 'replace' and 'update'. If omitted, the default value is 'replace'. In 'update' mode, new elements from the request are added or updated and existing items are not deleted. The items are identified by the 'URI' attribute.

{
    "type":"object",
    "title":"Replace File Links Request",
    "description":"The payload containing external file links to store in the specified inventory property.",
    "properties":{
        "operationType":{
            "type":"string",
            "description":"The type of the operation. Allowed values are 'replace' and 'update'. If omitted, the default value is 'replace'. In 'update' mode, new elements from the request are added or updated and existing items are not deleted. The items are identified by the 'URI' attribute.",
            "title":"Operation Type",
            "enum":[
                "replace",
                "update"
            ],
            "default":"replace"
        },
        "items":{
            "type":"array",
            "title":"Items",
            "description":"The collection of external file information objects.",
            "items":{
                "$ref":"#/definitions/externalFileInfoItem"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of external file information objects.

Show Source

• Array of: object External File Info Item
  Title: External File Info Item

  Information about a file stored in OCI Object Storage.

{
    "type":"array",
    "title":"Items",
    "description":"The collection of external file information objects.",
    "items":{
        "$ref":"#/definitions/externalFileInfoItem"
    }
}

Nested Schema : External File Info Item

Type: object

Title: External File Info Item

Information about a file stored in OCI Object Storage.

Show Source

• contentType(required): string
  Title: Content Type

  The media type of the file (for example 'image/jpeg'). This is used by the application to properly display the file in user interface.
• fileName(required): string
  Title: File Name

  File name.
• fileSize: integer
  Title: File Size

  Default Value: 999999

  The size of the file in bytes. It is used only to show the size of the file in UI. Default: 999999 (unknown).
• URI(required): string
  Title: URI

  Stored in Object Storage file uri ('https:///path-to-file'). This is used by the application to access the file content.

{
    "type":"object",
    "title":"External File Info Item",
    "description":"Information about a file stored in OCI Object Storage.",
    "required":[
        "fileName",
        "contentType",
        "URI"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "description":"File name.",
            "title":"File Name"
        },
        "contentType":{
            "type":"string",
            "description":"The media type of the file (for example 'image/jpeg'). This is used by the application to properly display the file in user interface.",
            "title":"Content Type"
        },
        "fileSize":{
            "type":"integer",
            "description":"The size of the file in bytes. It is used only to show the size of the file in UI. Default: 999999 (unknown).",
            "title":"File Size",
            "default":999999
        },
        "URI":{
            "type":"string",
            "description":"Stored in Object Storage file uri ('https://<server>/path-to-file'). This is used by the application to access the file content.",
            "title":"URI"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : External Files Info

Type: object

Title: External Files Info

The collection of information about external files stored for the specified inventory property.

Show Source

• items: array Items
  Title: Items

  The collection of external file information objects.

{
    "type":"object",
    "title":"External Files Info",
    "description":"The collection of information about external files stored for the specified inventory property.",
    "properties":{
        "items":{
            "type":"array",
            "title":"Items",
            "description":"The collection of external file information objects.",
            "items":{
                "$ref":"#/definitions/externalFileInfoItem"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The collection of external file information objects.

Show Source

• Array of: object External File Info Item
  Title: External File Info Item

  Information about a file stored in OCI Object Storage.

{
    "type":"array",
    "title":"Items",
    "description":"The collection of external file information objects.",
    "items":{
        "$ref":"#/definitions/externalFileInfoItem"
    }
}

Nested Schema : External File Info Item

Type: object

Title: External File Info Item

Information about a file stored in OCI Object Storage.

Show Source

• contentType(required): string
  Title: Content Type

  The media type of the file (for example 'image/jpeg'). This is used by the application to properly display the file in user interface.
• fileName(required): string
  Title: File Name

  File name.
• fileSize: integer
  Title: File Size

  Default Value: 999999

  The size of the file in bytes. It is used only to show the size of the file in UI. Default: 999999 (unknown).
• URI(required): string
  Title: URI

  Stored in Object Storage file uri ('https:///path-to-file'). This is used by the application to access the file content.

{
    "type":"object",
    "title":"External File Info Item",
    "description":"Information about a file stored in OCI Object Storage.",
    "required":[
        "fileName",
        "contentType",
        "URI"
    ],
    "properties":{
        "fileName":{
            "type":"string",
            "description":"File name.",
            "title":"File Name"
        },
        "contentType":{
            "type":"string",
            "description":"The media type of the file (for example 'image/jpeg'). This is used by the application to properly display the file in user interface.",
            "title":"Content Type"
        },
        "fileSize":{
            "type":"integer",
            "description":"The size of the file in bytes. It is used only to show the size of the file in UI. Default: 999999 (unknown).",
            "title":"File Size",
            "default":999999
        },
        "URI":{
            "type":"string",
            "description":"Stored in Object Storage file uri ('https://<server>/path-to-file'). This is used by the application to access the file content.",
            "title":"URI"
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(required): string
  The detailed description of this error.
• status(required): string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title",
        "status",
        "detail"
    ]
}

Back to Top