Create workstations
post
/fscmRestApi/resources/11.13.18.05/workstations
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
Root Schema : schema
Type:
Show Source
object-
Attachments: array
Attachments
Title:
AttachmentsThe attachments that are associated with workstations. -
AutomationEnabledFlag: boolean
Title:
Enable for automated execution of operationsMaximum Length:1Default Value:falseIndicates that the workstation is enabled for automated execution of work order operations. -
OrganizationCode: string
Abbreviation that identifies the inventory organization.
-
OrganizationId(required): integer
(int64)
Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
-
ProductionLineId: integer
(int64)
Value that uniquely identifies the production line. It???s a primary key generated by the application when a production line is created.
-
WorkCenterId(required): integer
(int64)
Title:
Work CenterValue that uniquely identifies the parent work center. It's a primary key that the application generates when it creates a work center. -
WorkstationCode(required): string
Title:
CodeMaximum Length:30Abbreviation that identifies the workstation. -
WorkstationDescription: string
Title:
DescriptionMaximum Length:240Description of the workstation. -
WorkstationDFF: array
Flexfields for Workstations
Title:
Flexfields for WorkstationsDescriptive flexfields are fields used to provide additional information for workstations. -
WorkstationEquipmentInstance: array
Workstation Equipment Instances
Title:
Workstation Equipment InstancesEquipment resource instances associated with the workstation. -
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
-
WorkstationName(required): string
Title:
NameMaximum Length:120Name of the workstation.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments that are associated with workstations.
Show Source
Nested Schema : Flexfields for Workstations
Type:
arrayTitle:
Flexfields for WorkstationsDescriptive flexfields are fields used to provide additional information for workstations.
Show Source
Nested Schema : Workstation Equipment Instances
Type:
arrayTitle:
Workstation Equipment InstancesEquipment resource instances associated with the workstation.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment PreviewsA preview of workstation attachments. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEValue that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextText content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of a topology manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page type attachment.
Nested Schema : Attachment Previews
Type:
arrayTitle:
Attachment PreviewsA preview of workstation attachments.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for workstations. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for workstations. -
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. You can use a flexfield with this resource. A flexfield is a flexible data field that your organization can use to modify your implementation without having to write programming code.
Nested Schema : workstations-WorkstationEquipmentInstance-item-post-request
Type:
Show Source
object-
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment instance that is associated with this workstation.
-
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
-
WsEquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment instance associated with workstation. It's a primary key that the application generates when it creates an equipment instance association with a workstation. This attribute is required.
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.
Root Schema : workstations-item-response
Type:
Show Source
object-
Attachments: array
Attachments
Title:
AttachmentsThe attachments that are associated with workstations. -
AutomationEnabledFlag: boolean
Title:
Enable for automated execution of operationsMaximum Length:1Default Value:falseIndicates that the workstation is enabled for automated execution of work order operations. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time of the creation of the row. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
Abbreviation that identifies the inventory organization.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
-
OrganizationName: string
Read Only:
trueMaximum Length:240Name of the inventory organization. -
ProductionLineCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the production line. -
ProductionLineId: integer
(int64)
Value that uniquely identifies the production line. It???s a primary key generated by the application when a production line is created.
-
ProductionLineName: string
Title:
NameRead Only:trueMaximum Length:120Name of the production line. -
WorkCenterCode: string
Title:
Work Center CodeRead Only:trueMaximum Length:30Abbreviation that identifies the parent work center. -
WorkCenterDescription: string
Title:
Work Center DescriptionRead Only:trueMaximum Length:240Description of the parent work center. -
WorkCenterId: integer
(int64)
Title:
Work CenterValue that uniquely identifies the parent work center. It's a primary key that the application generates when it creates a work center. -
WorkCenterName: string
Title:
Work CenterRead Only:trueMaximum Length:120Name of the parent work center. -
WorkstationCode: string
Title:
CodeMaximum Length:30Abbreviation that identifies the workstation. -
WorkstationDescription: string
Title:
DescriptionMaximum Length:240Description of the workstation. -
WorkstationDFF: array
Flexfields for Workstations
Title:
Flexfields for WorkstationsDescriptive flexfields are fields used to provide additional information for workstations. -
WorkstationEquipmentInstance: array
Workstation Equipment Instances
Title:
Workstation Equipment InstancesEquipment resource instances associated with the workstation. -
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
-
WorkstationName: string
Title:
NameMaximum Length:120Name of the workstation.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments that are associated with workstations.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Workstations
Type:
arrayTitle:
Flexfields for WorkstationsDescriptive flexfields are fields used to provide additional information for workstations.
Show Source
Nested Schema : Workstation Equipment Instances
Type:
arrayTitle:
Workstation Equipment InstancesEquipment resource instances associated with the workstation.
Show Source
Nested Schema : workstations-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
AttachmentsPreview: array
Attachment Previews
Title:
Attachment PreviewsA preview of workstation attachments. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEValue that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255Document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeSize of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextText content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of a topology manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Session login associated with the user who created the attachment.
Nested Schema : Attachment Previews
Type:
arrayTitle:
Attachment PreviewsA preview of workstation attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workstations-Attachments-AttachmentsPreview-item-response
Type:
Show Source
object-
ImageHeight: integer
Title:
Image HeightRead Only:trueHeight of the previewed image. -
ImageSource: string
Title:
Image SourceRead Only:truePreview of the image in base64 encoded PNG format. -
ImageWidth: integer
Title:
Image WidthRead Only:trueWidth of the previewed image. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PageNum: integer
Title:
Page NumberRead Only:trueNumber of the page in the preview.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : workstations-WorkstationDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for workstations. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for workstations. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. You can use a flexfield with this resource. A flexfield is a flexible data field that your organization can use to modify your implementation without having to write programming code.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : workstations-WorkstationEquipmentInstance-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time of the creation of the row. -
EquipmentInstanceCode: string
Title:
CodeRead Only:trueMaximum Length:80Abbreviation that identifies the equipment instance that is associated with this workstation. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment instance that is associated with this workstation.
-
EquipmentInstanceName: string
Title:
NameRead Only:trueMaximum Length:120Name of the equipment instance that is associated with this workstation. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResourceDescription: string
Title:
Resource DescriptionRead Only:trueMaximum Length:240Description of the production resource. -
ResourceId: integer
(int64)
Read Only:
trueValue that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource. -
ResourceName: string
Title:
Resource NameRead Only:trueMaximum Length:80Name of the production resource. -
WorkstationId: integer
(int64)
Value that uniquely identifies the workstation. It's a primary key that the application generates when it creates a workstation.
-
WsEquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment instance associated with workstation. It's a primary key that the application generates when it creates an equipment instance association with a workstation. This attribute is required.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- WorkstationId:
$request.path.WorkstationId
The attachments that are associated with workstations. - WorkstationId:
- WorkstationDFF
-
Parameters:
- WorkstationId:
$request.path.WorkstationId
Descriptive flexfields are fields used to provide additional information for workstations. - WorkstationId:
- WorkstationEquipmentInstance
-
Operation: /fscmRestApi/resources/11.13.18.05/workstations/{WorkstationId}/child/WorkstationEquipmentInstanceParameters:
- WorkstationId:
$request.path.WorkstationId
Equipment resource instances associated with the workstation. - WorkstationId:
Examples
This example describes how to create workstations.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/workstations"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{
"OrganizationId": 207,
"WorkstationCode": "SPRAY_WORKSTATION_A",
"WorkstationName": "Spray Paint WorkStation A",
"WorkstationDescription": "Spray Paint WorkStation A",
"WorkCenterName": "SPRAY_WC"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"OrganizationId": 207,
"OrganizationCode": "M1",
"OrganizationName": "Seattle Manufacturing",
"WorkstationId": 300100545640760,
"WorkStationCode": "SPRAY_WORKSTATION_A",
"WorkStationName": "Spray Paint WorkStation A",
"WorkStationDescription": "Spray Paint WorkStation A",
"WorkCenterId": 300100071642891,
"WorkCenterCode": "PAINT_WA",
"WorkCenterName": "SPRAY_WC",
"WorkCenterDescription": "Paint",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/workstations/300100545640760"
...
}
]
}