Jump to

• Request
• Response

Create an attachment

post

/fscmRestApi/resources/11.13.18.05/hedAttachments

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AttachmentDescription: string
  Title: Attachment Description

  Description of attachment.
• AttachmentFileContents: string (byte)
  Title: Attachment File Contents

  Attachment file.
• AttachmentFileName: string
  Title: Attachment File Name

  Name of attachment file.
• AttachmentFileURL: string
  Title: Attachment File URL

  URL for attachment file.
• AttachmentMetadata: string
  Title: Attachment Metadata

  Maximum Length: 4000

  Attachment metadata.
• AttachmentTitle: string
  Title: Attachment Title

  Title of attachment.
• AttachmentUploadedFileContentType: string
  Title: Attachment Uploaded File Content Type

  Content type for attachment file.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object the attachment has a relationship to.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  The object the attachment has a relationship to.

{
    "type":"object",
    "properties":{
        "AttachmentDescription":{
            "title":"Attachment Description",
            "type":"string",
            "description":"Description of attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentFileContents":{
            "title":"Attachment File Contents",
            "type":"string",
            "description":"Attachment file.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "AttachmentFileName":{
            "title":"Attachment File Name",
            "type":"string",
            "description":"Name of attachment file.",
            "nullable":false,
            "x-queryable":false
        },
        "AttachmentFileURL":{
            "title":"Attachment File URL",
            "type":"string",
            "description":"URL for attachment file.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentMetadata":{
            "title":"Attachment Metadata",
            "maxLength":4000,
            "type":"string",
            "description":"Attachment metadata.",
            "nullable":true
        },
        "AttachmentTitle":{
            "title":"Attachment Title",
            "type":"string",
            "description":"Title of attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentUploadedFileContentType":{
            "title":"Attachment Uploaded File Content Type",
            "type":"string",
            "description":"Content type for attachment file.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object the attachment has a relationship to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object the attachment has a relationship to.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : hedAttachments-item-response

Type: object

Show Source

• AttachmentDescription: string
  Title: Attachment Description

  Description of attachment.
• AttachmentFileContents: string (byte)
  Title: Attachment File Contents

  Attachment file.
• AttachmentFileName: string
  Title: Attachment File Name

  Name of attachment file.
• AttachmentFileURL: string
  Title: Attachment File URL

  URL for attachment file.
• AttachmentId: integer (int64)
  Title: Attachment Identifier

  Read Only: true

  Unique identifier for attachment.
• AttachmentMetadata: string
  Title: Attachment Metadata

  Maximum Length: 4000

  Attachment metadata.
• AttachmentTitle: string
  Title: Attachment Title

  Title of attachment.
• AttachmentUploadedFileContentType: string
  Title: Attachment Uploaded File Content Type

  Content type for attachment file.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object the attachment has a relationship to.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  The object the attachment has a relationship to.

{
    "type":"object",
    "properties":{
        "AttachmentDescription":{
            "title":"Attachment Description",
            "type":"string",
            "description":"Description of attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentFileContents":{
            "title":"Attachment File Contents",
            "type":"string",
            "description":"Attachment file.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "AttachmentFileName":{
            "title":"Attachment File Name",
            "type":"string",
            "description":"Name of attachment file.",
            "nullable":false,
            "x-queryable":false
        },
        "AttachmentFileURL":{
            "title":"Attachment File URL",
            "type":"string",
            "description":"URL for attachment file.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentId":{
            "title":"Attachment Identifier",
            "type":"integer",
            "description":"Unique identifier for attachment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttachmentMetadata":{
            "title":"Attachment Metadata",
            "maxLength":4000,
            "type":"string",
            "description":"Attachment metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentTitle":{
            "title":"Attachment Title",
            "type":"string",
            "description":"Title of attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentUploadedFileContentType":{
            "title":"Attachment Uploaded File Content Type",
            "type":"string",
            "description":"Content type for attachment file.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object the attachment has a relationship to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object the attachment has a relationship to.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top