Jump to

• Request
• Response

Create one measure type association for an activity type

post

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

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

• ActivityTypeCode: string
  Title: Activity Type Code

  Maximum Length: 100

  Code that identifies the activity type.
• 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.
• 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"
                ]
            }
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying a measure type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "mandatory":"true"
            }
        },
        "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-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"
    }
}

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

StandardLookupLOVVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_MEASURE_TYPES

The following properties are defined on the LOV link relation:

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

Back to Top