Root Schema : contracts-InternalSharedDocuments-item-response
Type: object
Show Source
-
AsyncTrackerId: string
Title: Asynchronous Upload Tracker Id
The async tracker ID of the internal shared document.
-
AttachedDocumentId: integer
(int64)
Title: Attached Document Id
The unique identifier of the attached internal shared document.
-
CategoryName: string
Title: Category
Maximum Length: 30
The code for the category to which the internal shared document is assigned.
-
ContentRepositoryFileShared: boolean
Title: Shared
Indicates if the internal shared document is shared in the content repository.
-
CreatedBy: string
Title: Created By
Read Only: true
Maximum Length: 255
The user who created the internal shared document.
-
CreatedByUserName: string
Title: Created By User Name
Read Only: true
The name of the user who created the internal shared document.
-
CreationDate: string
(date-time)
Title: Creation Date
Read Only: true
The date when the internal shared document was created.
-
DatatypeCode: string
Title: Type
Maximum Length: 30
Default Value: FILE
The code that identifies if the external shared document is a file or a URL.
-
Description: string
Title: Description
Maximum Length: 255
The description of the internal shared document.
-
DmDocumentId: string
Maximum Length: 255
The Dm document id of the internal shared document.
-
DmFolderPath: string
Title: Dm Folder Path
Maximum Length: 1000
The Dm folder path of the internal shared document.
-
DmVersionNumber: string
Maximum Length: 255
The Dm version number of the internal shared document.
-
DownloadInfo: string
Title: DownloadInfo
JSON object, represented as a string, containing information used to programmatically retrieve a file attachment.
-
ErrorStatusCode: string
Title: Error Status Code
The error status code for the internal shared document.
-
ErrorStatusMessage: string
Title: Error Status Message
The error status message for the internal shared document.
-
ExpirationDate: string
(date-time)
Title: Expiration Date
The expiration date of the internal shared document.
-
FileContents: string
(byte)
Title: File Contents
The file contents of the internal shared document.
-
FileName: string
Title: File Name
Maximum Length: 2048
The file name of the internal shared document. A file name or URL is required.
-
FileUrl: string
Title: File Url
The URL location of the internal shared document.
-
FileWebImage: string
(byte)
Title: File Web Image
Read Only: true
The base64 encoded image of the file displayed in .png format if the source is a convertible image.
-
LastUpdateDate: string
(date-time)
Title: Last Update Date
Read Only: true
The date when the internal shared document was last updated.
-
LastUpdatedBy: string
Title: Last Updated By
Read Only: true
Maximum Length: 255
The login user name associated with the user who last updated the internal shared document.
-
LastUpdatedByUserName: string
Title: Last Updated By User
Read Only: true
The name of the user who last updated the internal shared document.
-
links: array
Links
Title: Links
The link relations associated with the resource instance.
-
PostProcessingAction: string
Title: PostProcessingAction
The name of the action that can be performed after an attachment is uploaded.
-
Title: string
Title: Title
The title of the internal shared document.
-
UploadedFileContentType: string
Title: Uploaded File Content Type
The uploaded file content type of the internal shared document.
-
UploadedFileLength: integer
Title: File Size
The uploaded file length of the internal shared document.
-
UploadedFileName: string
Title: Uploaded File Name
The uploaded file name of the internal shared document.
-
UploadedText: string
Title: Uploaded Text
The uploaded text of the internal shared document.
-
Uri: string
Title: Uri
Maximum Length: 4000
The URI of the internal shared document.
-
Url: string
Title: Url
Maximum Length: 4000
The URL of the internal shared document. A file name or URL is required.
-
UserName: string
Title: User Name
Read Only: true
Maximum Length: 255
The name of the category to which the internal shared document is assigned.
{
"type":"object",
"properties":{
"CreationDate":{
"title":"Creation Date",
"type":"string",
"description":"The date when the internal shared document was created.",
"format":"date-time",
"nullable":false,
"readOnly":true,
"x-hints":{
"includeInCompactView":true
},
"x-queryable":true
},
"Description":{
"title":"Description",
"maxLength":"255",
"type":"string",
"description":"The description of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"FileName":{
"title":"File Name",
"maxLength":"2048",
"type":"string",
"description":"The file name of the internal shared document. A file name or URL is required.",
"nullable":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"true"
},
"x-queryable":true
},
"FileWebImage":{
"title":"File Web Image",
"type":"string",
"description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
"format":"byte",
"nullable":true,
"readOnly":true,
"x-queryable":false,
"x-hints":{
"XML_ELEMENT":"#hide",
"PAYLOADHINT":"Show"
}
},
"Uri":{
"title":"Uri",
"maxLength":"4000",
"type":"string",
"description":"The URI of the internal shared document.",
"nullable":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
},
"x-queryable":true
},
"Url":{
"title":"Url",
"maxLength":"4000",
"type":"string",
"description":"The URL of the internal shared document. A file name or URL is required.",
"nullable":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"true"
},
"x-queryable":true
},
"DmDocumentId":{
"maxLength":"255",
"type":"string",
"description":"The Dm document id of the internal shared document.",
"nullable":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"true",
"fnd:OA_TRANSLATABLE":"true"
},
"x-queryable":true
},
"AttachedDocumentId":{
"title":"Attached Document Id",
"type":"integer",
"description":"The unique identifier of the attached internal shared document.",
"format":"int64",
"nullable":false,
"x-hints":{
"includeInCompactView":true,
"precision":"18",
"fnd:FND_AUDIT_ATTR_ENABLED":"true",
"fnd:GLOBALLY_UNIQUE":"true"
},
"x-queryable":true
},
"UploadedFileContentType":{
"title":"Uploaded File Content Type",
"type":"string",
"description":"The uploaded file content type of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"DownloadInfo":{
"title":"DownloadInfo",
"type":"string",
"description":"JSON object, represented as a string, containing information used to programmatically retrieve a file attachment.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"CreatedByUserName":{
"title":"Created By User Name",
"type":"string",
"description":"The name of the user who created the internal shared document.",
"nullable":true,
"readOnly":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
},
"x-queryable":true
},
"links":{
"title":"Links",
"type":"array",
"description":"The link relations associated with the resource instance.",
"items":{
"$ref":"#/components/schemas/link"
}
},
"UploadedFileLength":{
"title":"File Size",
"type":"integer",
"description":"The uploaded file length of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"DmVersionNumber":{
"maxLength":"255",
"type":"string",
"description":"The Dm version number of the internal shared document.",
"nullable":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"true"
},
"x-queryable":true
},
"LastUpdatedBy":{
"title":"Last Updated By",
"maxLength":"255",
"type":"string",
"description":"The login user name associated with the user who last updated the internal shared document.",
"nullable":false,
"readOnly":true,
"x-hints":{
"includeInCompactView":true
},
"x-queryable":true
},
"ErrorStatusMessage":{
"title":"Error Status Message",
"type":"string",
"description":"The error status message for the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"UserName":{
"title":"User Name",
"maxLength":"255",
"type":"string",
"description":"The name of the category to which the internal shared document is assigned.",
"nullable":false,
"readOnly":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
},
"x-queryable":true
},
"CreatedBy":{
"title":"Created By",
"maxLength":"255",
"type":"string",
"description":"The user who created the internal shared document.",
"nullable":false,
"readOnly":true,
"x-hints":{
"includeInCompactView":true
},
"x-queryable":true
},
"DatatypeCode":{
"title":"Type",
"maxLength":"30",
"type":"string",
"description":"The code that identifies if the external shared document is a file or a URL.",
"nullable":false,
"default":"FILE",
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"true"
},
"x-queryable":true
},
"PostProcessingAction":{
"title":"PostProcessingAction",
"type":"string",
"description":"The name of the action that can be performed after an attachment is uploaded.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"Title":{
"title":"Title",
"type":"string",
"description":"The title of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"LastUpdatedByUserName":{
"title":"Last Updated By User",
"type":"string",
"description":"The name of the user who last updated the internal shared document.",
"nullable":true,
"readOnly":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
},
"x-queryable":true
},
"UploadedFileName":{
"title":"Uploaded File Name",
"type":"string",
"description":"The uploaded file name of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"FileUrl":{
"title":"File Url",
"type":"string",
"description":"The URL location of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"ContentRepositoryFileShared":{
"title":"Shared",
"type":"boolean",
"description":"Indicates if the internal shared document is shared in the content repository.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"FileContents":{
"title":"File Contents",
"type":"string",
"description":"The file contents of the internal shared document.",
"format":"byte",
"nullable":true,
"x-queryable":false,
"x-hints":{
"XML_ELEMENT":"#hide"
}
},
"ExpirationDate":{
"title":"Expiration Date",
"type":"string",
"description":"The expiration date of the internal shared document.",
"format":"date-time",
"nullable":true,
"x-hints":{
"includeInCompactView":true
},
"x-queryable":true
},
"ErrorStatusCode":{
"title":"Error Status Code",
"type":"string",
"description":"The error status code for the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"DmFolderPath":{
"title":"Dm Folder Path",
"maxLength":"1000",
"type":"string",
"description":"The Dm folder path of the internal shared document.",
"nullable":true,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"true"
},
"x-queryable":true
},
"UploadedText":{
"title":"Uploaded Text",
"type":"string",
"description":"The uploaded text of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"includeInCompactView":true,
"fnd:FND_AUDIT_ATTR_ENABLED":"false"
}
},
"CategoryName":{
"title":"Category",
"maxLength":"30",
"type":"string",
"description":"The code for the category to which the internal shared document is assigned.",
"nullable":true,
"x-hints":{
"includeInCompactView":true
},
"x-queryable":true
},
"LastUpdateDate":{
"title":"Last Update Date",
"type":"string",
"description":"The date when the internal shared document was last updated.",
"format":"date-time",
"nullable":false,
"readOnly":true,
"x-hints":{
"includeInCompactView":true,
"FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
},
"x-queryable":true
},
"AsyncTrackerId":{
"title":"Asynchronous Upload Tracker Id",
"type":"string",
"description":"The async tracker ID of the internal shared document.",
"nullable":true,
"x-queryable":false,
"x-hints":{
"DISPLAYHINT":"Hide",
"includeInCompactView":true,
"PAYLOADHINT":"Show"
}
}
}
}