Jump to

• Request
• Response
• Examples

Update one activity type

patch

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

Request

Path Parameters

• ActivityTypeId(required): integer(int64)
  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=

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

• EmissionTypeAssocs: array 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.
• EndDate: string (date)
  Title: End Date

  Date till when an activity type stays valid.
• MeasureTypeAssocs: array 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.
• Scope: string
  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.
• ScopeCategory: string
  Title: Scope Category

  Maximum Length: 80

  Category to which scope 3 events, purchase, or activity belongs.
• ScopeCategoryCode: string
  Title: Scope Category Code

  Maximum Length: 30

  Code that identifies a Scope 3 category.
• ScopeCode: string
  Title: Scope Code

  Maximum Length: 30

  Code that identifies a scope.
• StartDate: string (date)
  Title: Start Date

  Date from when an activity type becomes valid.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date from when an activity type becomes valid.",
            "format":"date",
            "nullable":true
        },
        "Scope":{
            "title":"Scope",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScopeCode"
                ]
            }
        },
        "ScopeCode":{
            "title":"Scope Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies a scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScopeCategory":{
            "title":"Scope Category",
            "maxLength":80,
            "type":"string",
            "description":"Category to which scope 3 events, purchase, or activity belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScopeCategoryCode"
                ]
            }
        },
        "MeasureTypeAssocs":{
            "title":"Measure Type Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivityTypes-MeasureTypeAssocs-item-patch-request"
            }
        },
        "EmissionTypeAssocs":{
            "title":"Emission Type Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivityTypes-EmissionTypeAssocs-item-patch-request"
            }
        },
        "ScopeCategoryCode":{
            "title":"Scope Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies a Scope 3 category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date till when an activity type stays valid.",
            "format":"date",
            "nullable":true
        }
    }
}

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

• Array of: object sustainabilityActivityTypes-EmissionTypeAssocs-item-patch-request

{
    "title":"Emission Type Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityActivityTypes-EmissionTypeAssocs-item-patch-request"
    }
}

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

• Array of: object sustainabilityActivityTypes-MeasureTypeAssocs-item-patch-request

{
    "title":"Measure Type Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityActivityTypes-MeasureTypeAssocs-item-patch-request"
    }
}

Nested Schema : sustainabilityActivityTypes-EmissionTypeAssocs-item-patch-request

Type: object

Show Source

• ActivityTypeCode: string
  Title: Activity Type Code

  Maximum Length: 100

  Code that identifies the activity type.
• EmissionTypeCode: string
  Title: Emission Type Code

  Maximum Length: 30

  Code identifying an emission type.

{
    "type":"object",
    "properties":{
        "ActivityTypeCode":{
            "title":"Activity Type Code",
            "maxLength":100,
            "type":"string",
            "description":"Code that identifies the activity type.",
            "nullable":false
        },
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying an emission type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "mandatory":"true"
            }
        }
    }
}

Nested Schema : sustainabilityActivityTypes-MeasureTypeAssocs-item-patch-request

Type: object

Show Source

• ActivityTypeCode: string
  Title: Activity Type Code

  Maximum Length: 100

  Code that identifies the activity type.

{
    "type":"object",
    "properties":{
        "ActivityTypeCode":{
            "title":"Activity Type Code",
            "maxLength":100,
            "type":"string",
            "description":"Code that identifies the activity type.",
            "nullable":false
        }
    }
}

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 : sustainabilityActivityTypes-item-response

Type: object

Show Source

• ActivityTypeCode: string
  Title: Activity Type Code

  Maximum Length: 100

  Code that identifies the activity type.
• ActivityTypeId: integer (int64)
  Title: Activity Type ID

  Read Only: true

  Unique identifier of an activity type that causes a sustainability impact.
• ActivityTypeName: string
  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the record was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 255

  Description of the type of activity.
• EmissionTypeAssocs: array 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.
• EndDate: string (date)
  Title: End Date

  Date till when an activity type stays valid.
• InUseFlag: boolean
  Title: In Use Indicator

  Read Only: true

  Identifies if the activity type is used in any activity emissions or emission factor mappings.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User login by whom the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureTypeAssocs: array 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.
• Scope: string
  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.
• ScopeCategory: string
  Title: Scope Category

  Maximum Length: 80

  Category to which scope 3 events, purchase, or activity belongs.
• ScopeCategoryCode: string
  Title: Scope Category Code

  Maximum Length: 30

  Code that identifies a Scope 3 category.
• ScopeCode: string
  Title: Scope Code

  Maximum Length: 30

  Code that identifies a scope.
• StartDate: string (date)
  Title: Start Date

  Date from when an activity type becomes valid.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User login by whom the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeName":{
            "title":"Activity Type",
            "maxLength":255,
            "type":"string",
            "description":"Translated name that identifies the activity type. For example, stationary combustion , mobile combustion, purchased electricity, and purchased goods and services.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ActivityTypeCode"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the type of activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "title":"Activity Type Code",
            "maxLength":100,
            "type":"string",
            "description":"Code that identifies the activity type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActivityTypeId":{
            "title":"Activity Type ID",
            "type":"integer",
            "description":"Unique identifier of an activity type that causes a sustainability impact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScopeCode":{
            "title":"Scope Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies a scope.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScopeCategory":{
            "title":"Scope Category",
            "maxLength":80,
            "type":"string",
            "description":"Category to which scope 3 events, purchase, or activity belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScopeCategoryCode"
                ]
            },
            "x-queryable":true
        },
        "InUseFlag":{
            "title":"In Use Indicator",
            "type":"boolean",
            "description":"Identifies if the activity type is used in any activity emissions or emission factor mappings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmissionTypeAssocs":{
            "title":"Emission Type Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivityTypes-EmissionTypeAssocs-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date till when an activity type stays valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date from when an activity type becomes valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Scope":{
            "title":"Scope",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScopeCode"
                ]
            },
            "x-queryable":true
        },
        "MeasureTypeAssocs":{
            "title":"Measure Type Associations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivityTypes-MeasureTypeAssocs-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ScopeCategoryCode":{
            "title":"Scope Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies a Scope 3 category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object sustainabilityActivityTypes-EmissionTypeAssocs-item-response

{
    "title":"Emission Type Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityActivityTypes-EmissionTypeAssocs-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 : 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

• Array of: object sustainabilityActivityTypes-MeasureTypeAssocs-item-response

{
    "title":"Measure Type Associations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityActivityTypes-MeasureTypeAssocs-item-response"
    }
}

Nested Schema : sustainabilityActivityTypes-EmissionTypeAssocs-item-response

Type: object

Show Source

• ActivityTypeCode: string
  Title: Activity Type Code

  Maximum Length: 100

  Code that identifies the activity type.
• EmissionType: string
  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.
• EmissionTypeAssocId: integer (int64)
  Title: Emission Type Association ID

  Read Only: true

  Unique identifier for the association of an emission type with an activity type.
• EmissionTypeCode: string
  Title: Emission Type Code

  Maximum Length: 30

  Code identifying an emission type.
• 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"
            }
        },
        "EmissionTypeAssocId":{
            "title":"Emission Type Association ID",
            "type":"integer",
            "description":"Unique identifier for the association of an emission type with an activity type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying an emission type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "mandatory":"true"
            },
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "title":"Activity Type Code",
            "maxLength":100,
            "type":"string",
            "description":"Code that identifies the activity type.",
            "nullable":false,
            "x-queryable":true
        },
        "EmissionType":{
            "title":"Emission Type",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionTypeCode"
                ]
            },
            "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."
        }
    }
}

Nested Schema : sustainabilityActivityTypes-MeasureTypeAssocs-item-response

Type: object

Show Source

• ActivityTypeCode: string
  Title: Activity Type Code

  Maximum Length: 100

  Code that identifies the activity type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureType: string
  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.
• MeasureTypeAssocId: integer (int64)
  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.
• MeasureTypeCode: string
  Title: Measure Type Code

  Maximum Length: 30

  Code identifying a measure type.

{
    "type":"object",
    "properties":{
        "MeasureType":{
            "title":"Measure Type",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureTypeCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MeasureTypeAssocId":{
            "title":"Measure Type Association ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying a measure type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "mandatory":"true"
            },
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "title":"Activity Type Code",
            "maxLength":100,
            "type":"string",
            "description":"Code that identifies the activity type.",
            "nullable":false,
            "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"
    }
}

Links

EmissionTypeAssocs

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivityTypes/{ActivityTypeId}/child/EmissionTypeAssocs

Parameters:

• ActivityTypeId: $request.path.ActivityTypeId

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.

FlexfieldContextPVA

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_DescriptiveFlexfieldCode%3DEMISSION_FACTOR_MAP%2CBind_ApplicationId%3D{calculated value}

The following properties are defined on the LOV link relation:

• Source Attribute: ActivityTypeCode; Target Attribute: ContextCode
• Display Attribute: Name, ContextCode

MeasureTypeAssocs

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivityTypes/{ActivityTypeId}/child/MeasureTypeAssocs

Parameters:

• ActivityTypeId: $request.path.ActivityTypeId

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.

ScopeCategoryCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BActiveDate%3D2025-05-23%2CLookupType%3DORA_SUS_SCOPE_CATEGORIES

The following properties are defined on the LOV link relation:

• Source Attribute: ScopeCategory; Target Attribute: Meaning
• Display Attribute: Meaning

ScopeCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BActiveDate%3D2025-05-23%2CLookupType%3DORA_SUS_SCOPES

The following properties are defined on the LOV link relation:

• Source Attribute: Scope; Target Attribute: Meaning
• Display Attribute: Meaning

Back to Top

Examples

This example describes how to update an activity type.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/ActivityTypeId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597335120"

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

{
 "Scope": "Scope 2 market-based",
 "StartDate": "2024-05-20"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "ActivityTypeId": 300100597335120,
  "ActivityTypeCode": "Purchased Energy Instrument",
  "ActivityTypeName": "Purchased Energy Instrument",
  "ScopeCode": "ORA_SUS_SCOPE2_MBM",
  "Scope": "Scope 2 market-based",
  "ScopeCategoryCode": null,
  "ScopeCategory": null,
  "StartDate": "2024-05-20",
  "EndDate": null,
  "CreatedBy": "CVBUYER01",
  "CreationDate": "2024-05-20T14:48:46+05:30",
  "LastUpdatedBy": "SUSQA01",
  "LastUpdateDate": "2024-05-21T12:34:32+05:30",
  "Description": "null",
  "InUseFlag": "false",
  "@context": {
    "key": "300100597335120",
    "headers": {
      "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
    },
    "links": [
      {
        "rel": "self",
        "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597335120",
        "name": "sustainabilityActivityTypes",
        "kind": "item"
      },
      {
        "rel": "canonical",
        "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597335120",
        "name": "sustainabilityActivityTypes",
        "kind": "item"
      },
      {
        "rel": "child",
        "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597335120/child/EmissionTypeAssocs",
        "name": "EmissionTypeAssocs",
        "kind": "collection"
      },
      {
        "rel": "child",
        "href": "https://servername/fscmRestApi/resources/version/sustainabilityActivityTypes/300100597335120/child/MeasureTypeAssocs",
        "name": "MeasureTypeAssocs",
        "kind": "collection"
      }
    ]
  }
}

Back to Top