Jump to

• Request
• Response

Create one batch record

post

/fscmRestApi/resources/11.13.18.05/sustainabilityProcessingBatches

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "ActionCode"
    ],
    "type":"object",
    "properties":{
        "ActionCode":{
            "title":"Action Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the action to be performed.",
            "nullable":false
        },
        "BatchEntries":{
            "title":"Batch Entries",
            "type":"array",
            "description":"Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityProcessingBatches-BatchEntries-item-post-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Batch Entries",
    "type":"array",
    "description":"Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityProcessingBatches-BatchEntries-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EmissionFactorMappingId":{
            "title":"Emission Factor Mapping ID",
            "type":"integer",
            "description":"Unique identifier of the emission factor mapping.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Unique identifier of the activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : sustainabilityProcessingBatches-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "title":"Action Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the action to be performed.",
            "nullable":false,
            "x-queryable":true
        },
        "BatchEntries":{
            "title":"Batch Entries",
            "type":"array",
            "description":"Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityProcessingBatches-BatchEntries-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BatchName":{
            "title":"Batch Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the batch record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"Unique identifier of the batch record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object sustainabilityProcessingBatches-BatchEntries-item-response

{
    "title":"Batch Entries",
    "type":"array",
    "description":"Batch ID with the corresponding record, either the activity ID or the emission factor mapping ID that needs to be processed for sustainability.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityProcessingBatches-BatchEntries-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : sustainabilityProcessingBatches-BatchEntries-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BatchEntryId":{
            "title":"Batch Entry ID",
            "type":"integer",
            "description":"Unique identifier of the batch entry.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmissionFactorMappingId":{
            "title":"Emission Factor Mapping ID",
            "type":"integer",
            "description":"Unique identifier of the emission factor mapping.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Unique identifier of the activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

BatchEntries

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityProcessingBatches/{BatchId}/child/BatchEntries

Parameters:

• 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.

process

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityProcessingBatches/{BatchId}/action/process

Parameters:

• 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.

Back to Top