Create one reference designator
post
/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/ReferenceDesignator
Request
Path Parameters
-
BillSequenceId(required): integer
Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
-
ComponentSequenceId(required): number
Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
Header Parameters
-
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.
-
Upsert-Mode:
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
-
ACDType: integer
Default Value:
1
Value that indicates if the reference designator is being added, modified, or deleted through a change line. -
ChangeLineId: integer
(int64)
Default Value:
-1
Value that uniquely identifies the change line corresponding to the reference designator. -
ChangeNotice: string
Maximum Length:
10
Change order notice to which the service operation added all the structure component changes. This attribute is used when the Needs Approval rule is run. -
Description: string
Title:
Description
Maximum Length:240
Description for the reference designator. -
ReferenceDesignator(required): string
Title:
Reference Designator
Maximum Length:15
Name of the reference designator. -
ReferenceDesignatorDFF: array
Flexfields for Reference Designators
Title:
Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator. -
ReferenceDesignatorSequenceId: integer
(int64)
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Flexfields for Reference Designators
Type:
array
Title:
Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context that references the reference designator. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
RefDesigSequenceId: integer
(int64)
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : itemStructures-Component-ReferenceDesignator-item-response
Type:
Show Source
object
-
ACDType: integer
Default Value:
1
Value that indicates if the reference designator is being added, modified, or deleted through a change line. -
ACDTypeValue: string
Read Only:
true
Maximum Length:255
Value that indicates if the substitute component is being added, modified, or deleted through a change line. -
ChangeLineId: integer
(int64)
Default Value:
-1
Value that uniquely identifies the change line corresponding to the reference designator. -
ChangeNotice: string
Maximum Length:
10
Change order notice to which the service operation added all the structure component changes. This attribute is used when the Needs Approval rule is run. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the structure was created. -
Description: string
Title:
Description
Maximum Length:240
Description for the reference designator. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the structure was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferenceDesignator: string
Title:
Reference Designator
Maximum Length:15
Name of the reference designator. -
ReferenceDesignatorDFF: array
Flexfields for Reference Designators
Title:
Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator. -
ReferenceDesignatorSequenceId: integer
(int64)
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Reference Designators
Type:
array
Title:
Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context that references the reference designator. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RefDesigSequenceId: integer
(int64)
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ReferenceDesignatorDFF
-
Parameters:
- BillSequenceId:
$request.path.BillSequenceId
- ComponentSequenceId:
$request.path.ComponentSequenceId
- ReferenceDesignatorSequenceId:
$request.path.ReferenceDesignatorSequenceId
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator. - BillSequenceId:
Examples
This example describes how to create one reference designator.
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/itemStructures/BillSequenceId/child/Component/ComponentSequenceId/child/ReferenceDesignator"
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.
{ "ReferenceDesignator": "RD001", "Description": "Add from Rest" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ACDType": 1, "ChangeLineId": -1, "ChangeNotice": null, "ReferenceDesignator": "RD001", "CreationDateTime": "2018-06-28T05:56:33.001+00:00", "LastUpdateDateTime": "2018-06-28T05:56:33.199+00:00", "Description": "Add from Rest", "ReferenceDesignatorSequenceId": 300100159659336, "ACDTypeValue": null, ... }