Create multiple document sequence derivation records
post
/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations
Request
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-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the selling business unit.
-
BusinessUnitName: string
Name of the selling business unit.
-
ContextDerivationCode: string
Maximum Length:
30Indicates if the record is a configuration record or a document sequence determining record for financials and shipping products. Valid values include CONTEXT_VALUES, DOCUMENT_NUMBERING, WSH_CONTEXT_VALUES, and WSH_DOCUMENT_NUMBERING. -
DocumentSequenceContext1: string
Maximum Length:
240Code that identifies the ship-from organization. -
DocumentSequenceContext10: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext2: string
Maximum Length:
240Type of order source line, such as sales order or return material authorization. -
DocumentSequenceContext3: string
Maximum Length:
240The Printed Fiscal Authorization Code that is a combination of organization and order type. -
DocumentSequenceContext4: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext5: string
Maximum Length:
240An attribute used to distinguish records. The value of the attribute is set to ARGENTINA SHIPMENT REMITO. -
DocumentSequenceContext6: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext7: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext8: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext9: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceDerivationId: integer
(int64)
The third segment of the document sequence number that is gapless and eight digits long. Values must not be provided for context derivation codes such as WSH_CONTEXT_VALUES and WSH_DOCUMENT_NUMBERING.
-
DocumentSequenceName: string
Maximum Length:
240Name of the document sequence setup for the specified context values. -
EffectiveEndDate: string
(date)
The date when the document sequence derivations record becomes ineffective. If the context derivation code is WSH_DOCUMENT_NUMBERING, it stores the date when the Electronic Fiscal Authorization Code becomes ineffective.
-
EffectiveStartDate: string
(date)
The date when the document sequence derivations record becomes effective. If the context derivation code is WSH_DOCUMENT_NUMBERING, it stores the date when the Electronic Fiscal Authorization Code becomes effective.
-
PrefixSuffixValue1: string
Maximum Length:
30The first character of the document sequence number. If the context derivation code is WSH_DOCUMENT_NUMBERING, valid values are R and X. -
PrefixSuffixValue2: string
Maximum Length:
30The second segment of the document sequence number that is four digits long. If the context derivation code is WSH_DOCUMENT_NUMBERING, the valid value is the four digit branch code. -
PrefixSuffixValue3: string
Maximum Length:
30An undefined context attribute for a document sequence. -
PrefixSuffixValue4: string
Maximum Length:
30An undefined context attribute for a document sequence. -
PrefixSuffixValue5: string
Maximum Length:
30An undefined context attribute for a document sequence.
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 : localizationDocumentSequenceDerivations-item-response
Type:
Show Source
object-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the selling business unit.
-
BusinessUnitName: string
Name of the selling business unit.
-
ContextDerivationCode: string
Maximum Length:
30Indicates if the record is a configuration record or a document sequence determining record for financials and shipping products. Valid values include CONTEXT_VALUES, DOCUMENT_NUMBERING, WSH_CONTEXT_VALUES, and WSH_DOCUMENT_NUMBERING. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the document sequence derivation record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the document sequence derivation record was created. -
DocumentSequenceContext1: string
Maximum Length:
240Code that identifies the ship-from organization. -
DocumentSequenceContext10: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext2: string
Maximum Length:
240Type of order source line, such as sales order or return material authorization. -
DocumentSequenceContext3: string
Maximum Length:
240The Printed Fiscal Authorization Code that is a combination of organization and order type. -
DocumentSequenceContext4: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext5: string
Maximum Length:
240An attribute used to distinguish records. The value of the attribute is set to ARGENTINA SHIPMENT REMITO. -
DocumentSequenceContext6: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext7: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext8: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceContext9: string
Maximum Length:
240An undefined context attribute for a document sequence. -
DocumentSequenceDerivationId: integer
(int64)
The third segment of the document sequence number that is gapless and eight digits long. Values must not be provided for context derivation codes such as WSH_CONTEXT_VALUES and WSH_DOCUMENT_NUMBERING.
-
DocumentSequenceName: string
Maximum Length:
240Name of the document sequence setup for the specified context values. -
EffectiveEndDate: string
(date)
The date when the document sequence derivations record becomes ineffective. If the context derivation code is WSH_DOCUMENT_NUMBERING, it stores the date when the Electronic Fiscal Authorization Code becomes ineffective.
-
EffectiveStartDate: string
(date)
The date when the document sequence derivations record becomes effective. If the context derivation code is WSH_DOCUMENT_NUMBERING, it stores the date when the Electronic Fiscal Authorization Code becomes effective.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the document sequence derivation record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the document sequence derivation record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who last updated the document sequence derivation record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueVersion number of the document sequence derivation record. -
PrefixSuffixValue1: string
Maximum Length:
30The first character of the document sequence number. If the context derivation code is WSH_DOCUMENT_NUMBERING, valid values are R and X. -
PrefixSuffixValue2: string
Maximum Length:
30The second segment of the document sequence number that is four digits long. If the context derivation code is WSH_DOCUMENT_NUMBERING, the valid value is the four digit branch code. -
PrefixSuffixValue3: string
Maximum Length:
30An undefined context attribute for a document sequence. -
PrefixSuffixValue4: string
Maximum Length:
30An undefined context attribute for a document sequence. -
PrefixSuffixValue5: string
Maximum Length:
30An undefined context attribute for a document sequence.
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.
Examples
The following example shows how to create multiple document sequence derivation records by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05
Example Request Payload
The following example shows the contents of the request body in JSON format:
{
"parts": [
{
"id": "part1",
"path": "/localizationDocumentSequenceDerivations",
"operation": "create",
"payload": {
"BusinessUnitName": "Vision Argentina",
"DocumentSequenceContext1": "ARA1",
"DocumentSequenceContext5": "ARGENTINA SHIPMENT REMITO",
"EffectiveStartDate": "2020-10-01",
"EffectiveEndDate": "2020-10-03",
"ContextDerivationCode": "WSH_CONTEXT_VALUES"
}
},
{
"id": "part2",
"path": "/localizationDocumentSequenceDerivations",
"operation": "create",
"payload": {
"BusinessUnitName": "Vision Argentina",
"DocumentSequenceContext1": "ARA1",
"DocumentSequenceContext5": "ARGENTINA SHIPMENT REMITO",
"EffectiveStartDate": "2020-11-01",
"EffectiveEndDate": "2020-11-03",
"ContextDerivationCode": "WSH_CONTEXT_VALUES"
}
}
]
}Example Response Body
The following example shows the contents of the response body in JSON format:
{
"parts": [
{
"id": "part1",
"path": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations",
"operation": "create",
"payload": {
"DocumentSequenceDerivationId": 300100185364495,
"BusinessUnitName": "Vision Argentina",
"BusinessUnitId": 300100095929597,
"DocumentSequenceContext1": "ARA1",
"DocumentSequenceContext2": null,
"DocumentSequenceContext3": null,
"DocumentSequenceContext4": null,
"DocumentSequenceContext5": "ARGENTINA SHIPMENT REMITO",
"DocumentSequenceContext6": null,
"DocumentSequenceContext7": null,
"DocumentSequenceContext8": null,
"DocumentSequenceContext9": null,
"DocumentSequenceContext10": null,
"DocumentSequenceName": null,
"PrefixSuffixValue1": null,
"PrefixSuffixValue2": null,
"PrefixSuffixValue3": null,
"PrefixSuffixValue4": null,
"PrefixSuffixValue5": null,
"EffectiveStartDate": "2020-10-01",
"EffectiveEndDate": "2020-10-03",
"CreatedBy": "FIN_USER1",
"CreationDate": "2019-11-11T09:10:29+00:00",
"LastUpdatedBy": "FIN_USER1",
"LastUpdateDate": "2019-11-11T09:10:29.861+00:00",
"LastUpdateLogin": "9630449A78130FDEE053458EF50A93E4",
"ObjectVersionNumber": 1,
"ContextDerivationCode": "WSH_CONTEXT_VALUES",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/300100185364495",
"name": "localizationDocumentSequenceDerivations",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/300100185364495",
"name": "localizationDocumentSequenceDerivations",
"kind": "item"
}
]
}
},
{
"id": "part2",
"path": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations",
"operation": "create",
"payload": {
"DocumentSequenceDerivationId": 300100185364496,
"BusinessUnitName": "Vision Argentina",
"BusinessUnitId": 300100095929597,
"DocumentSequenceContext1": "ARA1",
"DocumentSequenceContext2": null,
"DocumentSequenceContext3": null,
"DocumentSequenceContext4": null,
"DocumentSequenceContext5": "ARGENTINA SHIPMENT REMITO",
"DocumentSequenceContext6": null,
"DocumentSequenceContext7": null,
"DocumentSequenceContext8": null,
"DocumentSequenceContext9": null,
"DocumentSequenceContext10": null,
"DocumentSequenceName": null,
"PrefixSuffixValue1": null,
"PrefixSuffixValue2": null,
"PrefixSuffixValue3": null,
"PrefixSuffixValue4": null,
"PrefixSuffixValue5": null,
"EffectiveStartDate": "2020-11-01",
"EffectiveEndDate": "2020-11-03",
"CreatedBy": "FIN_USER1",
"CreationDate": "2019-11-11T09:10:29.358+00:00",
"LastUpdatedBy": "FIN_USER1",
"LastUpdateDate": "2019-11-11T09:10:29.905+00:00",
"LastUpdateLogin": "9630449A78130FDEE053458EF50A93E4",
"ObjectVersionNumber": 1,
"ContextDerivationCode": "WSH_CONTEXT_VALUES",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/300100185364496",
"name": "localizationDocumentSequenceDerivations",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/300100185364496",
"name": "localizationDocumentSequenceDerivations",
"kind": "item"
}
]
}
}
]
}