Get one activity type

get

/fscmRestApi/resources/11.13.18.05/sustainabilityActivityTypes/{ActivityTypeId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : sustainabilityActivityTypes-item-response
Type: object
Show Source
  • Title: Activity Type Code
    Maximum Length: 100
    Code that identifies the activity type.
  • Title: Activity Type ID
    Read Only: true
    Unique identifier of an activity type that causes a sustainability impact.
  • Title: Activity Type
    Read Only: true
    Maximum Length: 255
    Translated name that identifies the activity type. For example, stationary combustion , mobile combustion, purchased electricity, and purchased goods and services.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the record.
  • Title: Creation Date
    Read Only: true
    Date and time when the record was created.
  • Title: Description
    Read Only: true
    Maximum Length: 255
    Description of the type of activity.
  • Emission Type Associations
    Title: Emission Type Associations
    Represent the association between an emission type and an activity type. An emission type is a substance such as a greenhouse gas or an air pollutant that's emitted by a process such as fossil fuel combustion or a chemical reaction. For example, CO2 and CH4 could be associated with an activity type, stationary combustion.
  • Title: End Date
    Date till when an activity type stays valid.
  • Title: In Use Indicator
    Read Only: true
    Identifies if the activity type is used in any activity emissions or emission factor mappings.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User login by whom the record was last updated.
  • Links
  • Measure Type Associations
    Title: Measure Type Associations
    Represent the association between a measure type and an activity type. A measure type is a variable whose value is multiplied by an emission factor to obtain the emissions for an emission type. The value of a measure type has an associated unit of measure. For example, Fuel Quantity might have Gallon as the unit of measure.
  • Title: Scope
    Maximum Length: 255
    Scope of emissions as defined by the Greenhouse Gas Protocol, that's, Scope 1, Scope 2 Location-based, Scope 2 Market-based or Scope 3.
  • Title: Scope Category
    Maximum Length: 80
    Category to which scope 3 events, purchase, or activity belongs.
  • Title: Scope Category Code
    Maximum Length: 30
    Code that identifies a Scope 3 category.
  • Title: Scope Code
    Maximum Length: 30
    Code that identifies a scope.
  • Title: Start Date
    Date from when an activity type becomes valid.
Nested Schema : Emission Type Associations
Type: array
Title: Emission Type Associations
Represent the association between an emission type and an activity type. An emission type is a substance such as a greenhouse gas or an air pollutant that's emitted by a process such as fossil fuel combustion or a chemical reaction. For example, CO2 and CH4 could be associated with an activity type, stationary combustion.
Show Source
Nested Schema : Measure Type Associations
Type: array
Title: Measure Type Associations
Represent the association between a measure type and an activity type. A measure type is a variable whose value is multiplied by an emission factor to obtain the emissions for an emission type. The value of a measure type has an associated unit of measure. For example, Fuel Quantity might have Gallon as the unit of measure.
Show Source
Nested Schema : sustainabilityActivityTypes-EmissionTypeAssocs-item-response
Type: object
Show Source
  • Title: Activity Type Code
    Maximum Length: 100
    Code that identifies the activity type.
  • Title: Emission Type
    Maximum Length: 255
    Translated name that identifies the emission type, which is a substance such as a greenhouse gas or an air pollutant that's emitted when processes such as fossil fuel combustion or chemical reactions occur.
  • Title: Emission Type Association ID
    Read Only: true
    Unique identifier for the association of an emission type with an activity type.
  • Title: Emission Type Code
    Maximum Length: 30
    Code identifying an emission type.
  • Links
Nested Schema : sustainabilityActivityTypes-MeasureTypeAssocs-item-response
Type: object
Show Source
  • Title: Activity Type Code
    Maximum Length: 100
    Code that identifies the activity type.
  • Links
  • Title: Measure Type
    Maximum Length: 255
    Translated name that identifies the measure type. A measure type is a variable whose value is multiplied by an emission factor to obtain the emissions for an emission type.
  • Title: Measure Type Association ID
    Read Only: true
    Unique identifier for the association of a measure type with an activity type. For example, the measure type for stationary combustion could be fuel quantity.
  • Title: Measure Type Code
    Maximum Length: 30
    Code identifying a measure type.
Back to Top

Examples

This example describes how to get one activity type.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/ActivityTypeId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597010458"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "ActivityTypeId": 300100597010458,
    "ActivityTypeCode": "Purchased Energy",
    "ActivityTypeName": "Purchased Energy",
    "ScopeCode": "ORA_SUS_SCOPE2_LBM",
    "Scope": "Scope 2 location-based",
    "ScopeCategoryCode": null,
    "ScopeCategory": null,
    "StartDate": "2020-01-01",
    "EndDate": null,
    "CreatedBy": "SUSPMADMIN",
    "CreationDate": "2024-04-02T07:07:14.122+00:00",
    "LastUpdatedBy": "SUSPMADMIN",
    "LastUpdateDate": "2024-04-02T07:07:14.327+00:00",
    "Description": "Activity Type for tracking Purchased Energy",
    "InUseFlag": "true",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597010458",
            "name": "sustainabilityActivityTypes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597010458",
            "name": "sustainabilityActivityTypes",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597010458/child/EmissionTypeAssocs",
            "name": "EmissionTypeAssocs",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597010458/child/MeasureTypeAssocs",
            "name": "MeasureTypeAssocs",
            "kind": "collection"
        }
    ]
}
Back to Top