Create one batch record
post
/fscmRestApi/resources/11.13.18.05/sustainabilityProcessingBatches
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActionCode(required): string
Title:
Action Code
Maximum Length:30
Code that identifies the action to be performed. -
BatchEntries: array
Batch Entries
Title:
Batch Entries
Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability.
Nested Schema : Batch Entries
Type:
array
Title:
Batch Entries
Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
ActivityId: integer
(int64)
Title:
Activity ID
Unique identifier of the activity record. -
EmissionFactorMappingId: integer
(int64)
Title:
Emission Factor Mapping ID
Unique identifier of the emission factor mapping.
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 : sustainabilityProcessingBatches-item-response
Type:
Show Source
object
-
ActionCode: string
Title:
Action Code
Maximum Length:30
Code that identifies the action to be performed. -
BatchEntries: array
Batch Entries
Title:
Batch Entries
Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability. -
BatchId: integer
(int64)
Title:
Batch ID
Read Only:true
Unique identifier of the batch record. -
BatchName: string
Title:
Batch Name
Read Only:true
Maximum Length:240
Name of the batch record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Batch Entries
Type:
array
Title:
Batch Entries
Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : sustainabilityProcessingBatches-BatchEntries-item-response
Type:
Show Source
object
-
ActivityId: integer
(int64)
Title:
Activity ID
Unique identifier of the activity record. -
BatchEntryId: integer
(int64)
Title:
Batch Entry ID
Read Only:true
Unique identifier of the batch entry. -
EmissionFactorMappingId: integer
(int64)
Title:
Emission Factor Mapping ID
Unique identifier of the emission factor mapping. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- BatchEntries
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityProcessingBatches/{BatchId}/child/BatchEntriesParameters:
- BatchId:
$request.path.BatchId
Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability. - BatchId:
- process
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityProcessingBatches/{BatchId}/action/processParameters:
- BatchId:
$request.path.BatchId
Processes a batch entry based on the action code. The actions for activity records are validate, post to ledger, cancel, and delete. The action for emission factor mapping is delete. - BatchId: